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":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"RestoreRequestBody":{"description":"恢复到已有实例的请求body","properties":{"backup_id":{"description":"备份文件名称。根据备份文件恢复到已有的实例。","type":"string"},"password":{"description":"实例密码。\n取值范围:长度为8~32位,必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_=+?的组合。\n  - 不传入密码时,恢复后,备份文件中保留的密码将覆盖原有实例的密码。\n  - 传入密码时,恢复后,将使用该密码覆盖原有实例的密码。","type":"string"}},"required":["backup_id"]},"RestoreResponseBody":{"properties":{"job_id":{"description":"任务ID。","type":"string"}},"required":["job_id"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"70b367e2a005489a82e5becc16833944","info_version":"v3","method":"post","name":"RestoreExistingInstance","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/recovery":{"post":{"description":"恢复到已有实例","operationId":"RestoreExistingInstance","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":"054e292c9880d4992f02c0196d3ea468"},{"description":"实例Id,可以调用[5.3.3 查询实例列表和详情](x-wc://file=zh-cn_topic_0000001397299481.xml)接口获取。如果未申请实例,可以调用[5.3.1 创建实例](x-wc://file=zh-cn_topic_0000001397139461.xml)接口创建。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"61f554065802400c9c33f87e8114f081in10"},{"description":"请求体","in":"body","name":"restore_request","required":true,"schema":{"$ref":"#/definitions/RestoreRequestBody"}}],"responses":{"202":{"description":"Success","examples":{"application/json":{"job_id":"f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"}},"schema":{"$ref":"#/definitions/RestoreResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"恢复到已有实例","tags":["备份与恢复"],"x-constraint":"该接口支持如下数据库实例:\n- GeminiDB Mongo副本集4.0\n\n正在恢复的实例不能进行恢复到已有实例的操作。\n\n只可选择与原实例同版本或更高版本,同规格或更高规格,且存储空间大于或等于备份文件的已有实例进行恢复。","x-is-registered":"N","x-request-examples-1":{"backup_id":"a8114c9b30cf42b6ba7752bfa62dee0bbr10","password":"******"},"x-request-examples-description-1":"","x-request-examples-url-1":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/recovery","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"恢复到已有实例","tags":"备份与恢复","uri":null,"version":"2.0"}