huawei-cloud-api-definitions-GaussDB 0.1.20250124

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"UpdateBackupOffsitePolicyInfo":{"description":"备份策略信息。","properties":{"destination_project_id":{"description":"设置跨区域备份策略的目标project ID。\n\n  租户在某一Region下的project ID。                          \n\n  获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdbformysql/gaussdbformysql_10_0004.html)。","type":"string"},"destination_region":{"description":"设置跨区域备份策略的目标区域。","type":"string"},"keep_days":{"description":"指定已生成的备份文件可以保存的天数。\n\n取值范围:1~1825。","type":"integer"},"open_auto_backup":{"description":"是否开启跨区域全量备份。\n- true:开启跨区域全量备份。\n- false:关闭跨区域全量备份。","type":"boolean"},"open_incremental_backup":{"description":"是否开启跨区域增量备份。\n- true:开启跨区域增量备份,当open_auto_backup开启时才可以开启。\n- false:关闭跨区域增量备份。","type":"boolean"}},"required":["open_auto_backup","open_incremental_backup","destination_project_id","destination_region","keep_days"]},"UpdateBackupOffsitePolicyRequestBody":{"properties":{"backup_policy":{"$ref":"#/definitions/UpdateBackupOffsitePolicyInfo"}},"required":["backup_policy"]},"UpdateBackupOffsitePolicyResp":{"properties":{"result":{"description":"结果。","type":"string"}}}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"cb6fbd1475e744b881b54870cad91725","info_version":"v3","method":"put","name":"UpdateBackupOffsitePolicy","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/backups/offsite-policy":{"put":{"description":"设置跨区备份策略。","operationId":"UpdateBackupOffsitePolicy","parameters":[{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一Region下的project ID。                          \n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdbformysql/gaussdbformysql_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"61a4ea66210545909d74a05c27a7179ein07"},{"description":"请求体。","in":"body","name":"UpdateBackupOffsitePolicyRequestBody","required":true,"schema":{"$ref":"#/definitions/UpdateBackupOffsitePolicyRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"result":"success"}},"schema":{"$ref":"#/definitions/UpdateBackupOffsitePolicyResp"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"设置跨区备份策略","tags":["备份管理"],"x-is-registered":"N","x-request-examples-1":{"backup_policy":{"destination_project_id":"fd710c89089a448aa2e666ab15817090","destination_region":"cn-north-7","keep_days":1,"open_auto_backup":true,"open_incremental_backup":false}},"x-request-examples-description-1":"设置跨区备份策略。","x-request-examples-url-1":"PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/offsite-policy","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"设置跨区备份策略","tags":"备份管理","uri":null,"version":"2.0"}