huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240113

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"QueryRestoreList":{"description":"可恢复的实例信息结构体","properties":{"engine_name":{"description":"引擎名称","type":"string"},"engine_version":{"description":"引擎版本","type":"string"},"instance_id":{"description":"实例ID","type":"string"},"instance_mode":{"description":"实例模式","type":"string"},"security_group_ids":{"description":"安全组ID列表","items":{"type":"string"},"type":"array"},"subnet_ids":{"description":"子网ID列表","items":{"type":"string"},"type":"array"},"vpc_id":{"description":"VPC ID。","type":"string"}},"required":["instance_id","instance_mode","engine_name","engine_version","vpc_id","subnet_ids","security_group_ids"]},"ShowRestoreListResponseBody":{"properties":{"restorable_instances":{"description":"可恢复的实例信息","items":{"$ref":"#/definitions/QueryRestoreList"},"type":"array"},"total_count":{"description":"可恢复的实例总数","format":"int32","type":"integer"}},"required":["total_count","restorable_instance"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"371e65b1741d4db8adbad5060a8ac0fe","info_version":"v3","method":"get","name":"ShowRestorableList","parameters":{},"paths":{"/v3/{project_id}/backups/{backup_id}/restorable-instances":{"get":{"description":"查询用户可恢复的实例列表","operationId":"ShowRestorableList","parameters":[{"description":"用户token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"用户在某一region下的projectId。","in":"path","name":"project_id","required":true,"type":"string","x-example":"375d8d8fad1f43039e23d3b6c0f60a19"},{"description":"备份文件ID","in":"path","name":"backup_id","required":true,"type":"string","x-example":"2b19a3348108411baf7c46cf8d668e90br10"},{"description":"索引位置偏移量。取值大于或等于0。不传该参数时,查询偏移量默认为0。","in":"query","name":"offset","required":false,"type":"integer","x-example":0},{"description":"查询个数上限值。取值范围:1~100。不传该参数时,默认查询前100条信息。","in":"query","name":"limit","required":false,"type":"integer","x-example":100}],"responses":{"200":{"description":"Success","examples":{"application/json":{"restorable_instances":[{"engine_name":"geminimongodb","engine_version":"4.0.3.11","instance_id":"6aef2786115341b6a18a67e0ee6ef664in10","instance_mode":"ReplicaSet","security_group_ids":["7aa51dbf-5b63-40db-9724-dad3c4828b58"],"subnet_ids":["f1df08c5-71d1-406a-aff0-de435a51007"],"vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"}],"total_count":1}},"schema":{"$ref":"#/definitions/ShowRestoreListResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询可恢复的实例列表","tags":["备份与恢复"],"x-constraint":"该接口支持如下数据库实例:\n- GeminiDB Mongo副本集4.0","x-is-registered":"N","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/backups/2b19a3348108411baf7c46cf8d668e90br10/restorable-instances?offset=0&limit=100","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询可恢复的实例列表","tags":"备份与恢复","uri":null,"version":"2.0"}