# 设置实例容灾倒换配置 - ConfiguringDRSwitchoverforanInstance #### 功能介绍 设置实例容灾倒换配置。 #### 接口约束 - 该接口支持GeminiDB Cassandra数据库实例。 - 仅支持在原始主实例（即搭建容灾时所使用的主实例）上进行设置。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=SetDisasterRecoverySettings)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:setDisasterSettings | write | - | - | nosql:dr:setDisasterRecoverySettings | - | #### URI PUT /v3/{project_id}/instances/disaster-recovery/settings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | disaster_recovery_settings | 否 | Array of [SwitchoverRatio] objects | **参数解释：** 容灾切换的故障节点比例列表。 **约束限制：** 不涉及。 | 表4SwitchoverRatio | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释** **：** 实例ID，可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | switchover_ratio | 否 | Integer | **参数解释：** 容灾切换的故障节点比例，单位：%。 **约束限制：** 下限是50，步长是10，最大是100。 **取值范围：** - 50：故障节点比例为50%。 - 60：故障节点比例为60%。 - 70：故障节点比例为70%。 - 80：故障节点比例为80%。 - 90：故障节点比例为90%。 - 100：故障节点比例为100%。 **默认取值：** 100。 | | sync_delay | 否 | Long | **参数解释：** 容灾实例的数据同步时延，单位为秒（s）。当容灾实例与主实例的同步时延超过该值时，将不触发容灾倒换。默认情况下不进行时延判断。 **约束限制：** 如果传入此参数，最小为10s。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | successed_instance_ids | Array of strings | **参数解释：** 设置容灾切换故障节点比例成功的实例列表。 | #### 请求示例 - 设置实例容灾切换的故障节点比例。 ``` PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings { "disaster_recovery_settings" : [ { "instance_id" : "d74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 50 }, { "instance_id" : "e74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 100, "sync_delay" : 10 } ] } ``` - 设置实例容灾切换的故障节点比例和数据同步时延。 ``` PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings { "disaster_recovery_settings" : [ { "instance_id" : "d74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 50, "sync_delay" : 300000 }, { "instance_id" : "e74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 100, "sync_delay" : 600000 } ] } ``` #### 响应示例 **状态码： 200** Success. ``` { "successed_instance_ids" : [ "d74162b942604190b991d1c39772a66ain06", "e74162b942604190b991d1c39772a66ain06" ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。