huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20251128

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ListDbCacheMappingsResponseBody":{"properties":{"dbcache_mappings":{"description":"内存加速映射信息。","items":{"$ref":"#/definitions/QueryDBCacheMappingResponse"},"type":"array"},"total_count":{"description":"总记录数。","format":"int32","type":"integer"}},"required":["total_count","dbcache_mappings"],"type":"object"},"QueryDBCacheMappingResponse":{"description":"内存加速映射信息。","properties":{"created":{"description":"内存加速映射创建时间。","type":"string"},"id":{"description":"内存加速映射ID。","type":"string"},"name":{"description":"内存加速映射名称。","type":"string"},"rule_count":{"description":"该内存加速映射下的规则数量。","format":"int32","type":"integer"},"source_instance_id":{"description":"源实例ID。","type":"string"},"source_instance_name":{"description":"源实例名称。","type":"string"},"status":{"description":"内存加速映射关系。\n - normal: 表示内存加速映射正常。\n - creating: 表示内存加速映射创建中。\n - createfail: 表示内存加速映射创建失败。\n - deleting: 表示内存加速映射解除中。\n - stopped: 表示内存加速映射停止。\n - deleted: 表示内存加速映射已解除。","example":"normal","type":"string"},"target_instance_id":{"description":"目标实例ID。","type":"string"},"target_instance_name":{"description":"目标实例名称。","type":"string"},"updated":{"description":"内存加速映射最新变更的时间。","type":"string"}},"required":["id","name","source_instance_id","source_instance_name","target_instance_id","target_instance_name","status","created","updated"],"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"abccd14f90cb4cd4b6b522cf087e1ca1","info_version":"v3","method":"get","name":"ListDbCacheMappings","parameters":{},"paths":{"/v3/{project_id}/dbcache/mappings":{"get":{"description":"根据指定条件查询内存加速映射关系列表和详情。","operationId":"ListDbCacheMappings","parameters":[{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"映射ID,可以调用“查询内存加速映射列表和详情”接口获取。","in":"query","name":"id","required":false,"type":"string"},{"description":"映射名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。","in":"query","name":"name","required":false,"type":"string"},{"description":"源实例ID。","in":"query","name":"source_instance_id","required":false,"type":"string"},{"description":"源实例名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。","in":"query","name":"source_instance_name","required":false,"type":"string"},{"description":"目标实例ID。","in":"query","name":"target_instance_id","required":false,"type":"string"},{"description":"目标实例名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。","in":"query","name":"target_instance_name","required":false,"type":"string"},{"description":"索引位置,偏移量。\n从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。 取值必须为数字,不能为负数。","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"查询个数上限值。取值范围:1~100。不传该参数时,默认查询前100条信息。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"dbcache_mappings":[{"created":"2024-01-17T07:05:52","id":"0231e002-d278-4df8-815c-8284164168e5","name":"dbcache_rule_01","rule_count":10,"source_instance_id":"d8e6ca5a624745bcb546a227aa3ae1cfin01","source_instance_name":"source_name","status":"normal","target_instance_id":"9136fd2a9fcd405ea4674276ce36dae8in12","target_instance_name":"target_name","updated":"2024-01-20T08:07:02"}],"total_count":1}},"schema":{"$ref":"#/definitions/ListDbCacheMappingsResponseBody"}}},"summary":"查询内存加速映射列表和详情","tags":["实例管理"],"x-api-type":"open-api","x-constraint":"仅支持GeminiDB Redis主备类型实例。","x-is-registered":"Y","x-order":0,"x-request-examples-description-1":"查询前10个内存加速映射信息","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/mappings?offset=0&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询内存加速映射列表和详情","tags":"实例管理","uri":null,"version":"2.0"}