huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20260612

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"]},"SetDisasterRecoverySettingsRequestBody":{"properties":{"disaster_recovery_settings":{"description":"**参数解释:**\n容灾切换的故障节点比例列表。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","items":{"$ref":"#/definitions/SetSwitchoverRatioInfo"},"type":"array"}},"required":["successed_instance_ids"]},"SetDisasterRecoverySettingsResponseBody":{"properties":{"successed_instance_ids":{"description":"设置容灾切换故障节点比例成功的实例列表。","items":{"type":"string"},"type":"array"}},"required":["successed_instance_ids"]},"SetSwitchoverRatioInfo":{"properties":{"instance_id":{"description":"**参数解释:**\n实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"switchover_ratio":{"description":"**参数解释:**\n容灾切换的故障节点比例。\n**约束限制**:\n下限是50,步长是10,最大是100。\n**取值范围:**\n- 50\n- 60\n- 70\n- 80\n- 90\n- 100\n**默认取值:**\n100。","enum":[50,60,70,80,90,100],"type":"integer"},"sync_delay":{"description":"**参数解释:**\n容灾实例数据同步时延,单位s。备实例和主实例同步时延超过该值时,不进行容灾倒换。默认不判断时延。\n**约束限制:**\n若需指定此参数,最小为10s。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","format":"int64","type":"integer"}},"required":["instance_id"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"a0dda9318cdb40f4bc4d4e5ccb8b92df","info_version":"v3","method":"put","name":"SetDisasterRecoverySettings","parameters":{},"paths":{"/v3/{project_id}/instances/disaster-recovery/settings":{"put":{"description":"设置实例容灾切换的故障节点比例。","operationId":"SetDisasterRecoverySettings","parameters":[{"description":"**参数解释:**\n用户Token。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"**参数解释:**\n租户在某一region下的project ID。获取方法请参见“获取项目ID”。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"请求体。","in":"body","name":"SetDisasterRecoverySettingsRequestBody","required":true,"schema":{"$ref":"#/definitions/SetDisasterRecoverySettingsRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"successed_instance_ids":["d74162b942604190b991d1c39772a66ain06","e74162b942604190b991d1c39772a66ain06"]}},"schema":{"$ref":"#/definitions/SetDisasterRecoverySettingsResponseBody"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"设置实例容灾切换的故障节点比例","tags":["容灾管理"],"x-api-type":"open-api","x-apigateway-ratelimit":"nosql_default_policy","x-constraint":"该接口支持GeminiDB Cassandra数据库实例。\n仅支持主实例,且该实例为原始容灾主实例(搭建容灾时的主实例)进行设置。","x-is-registered":"Y","x-request-examples-1":{"disaster_recovery_settings":[{"instance_id":"d74162b942604190b991d1c39772a66ain06","switchover_ratio":50},{"instance_id":"e74162b942604190b991d1c39772a66ain06","switchover_ratio":100,"sync_delay":10}]},"x-request-examples-description-1":"设置实例容灾切换的故障节点比例。","x-request-examples-url-1":"PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"设置实例容灾切换的故障节点比例","tags":"容灾管理","uri":null,"version":"2.0"}