
# 查询实例容灾倒换配置 - QueryingtheDRSwitchoverConfigurationsofInstances
#### 功能介绍
查询实例容灾倒换配置。
#### 接口约束
该接口支持GeminiDB Cassandra 数据库实例。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowDisasterRecoverySettings)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                           | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                                    | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:listDisasterSettings | List | -           | -   | nosql:dr:listDisasterRecoverySettings | -      |
     
  
 
#### URI
GET /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个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| 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)接口创建。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| offset      | 否    | Integer | **参数解释：** 索引位置偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 **约束限制：** 取值必须为数字，不能为负数。 **取值范围：** 非负整数。 **默认取值：** 0。                                                                                                                                                                |
| limit       | 否    | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~50。 **默认取值：** 50。不传该参数时，默认查询前50条信息。                                                                                                                                                                                                                              |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数                         | 参数类型                                                                  | 描述                                                                                                                             |
|:---|:---|:---|
| disaster_recovery_settings | Array of [SwitchoverRatio] objects | **参数解释：** 容灾切换的故障节点比例列表。                                                                        |
| total_count                | Integer                                                               | **参数解释：** 总记录数。 **取值范围：** 不涉及。 |
   
 表5SwitchoverRatio 
| 参数               | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| 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：当故障节点比例达到50%时触发容灾切换。  - 60：当故障节点比例达到60%时触发容灾切换。  - 70：当故障节点比例达到70%时触发容灾切换。  - 80：当故障节点比例达到80%时触发容灾切换。  - 90：当故障节点比例达到90%时触发容灾切换。  - 100：当故障节点比例达到100%时触发容灾切换。   |
| sync_delay       | Long    | **参数解释：** 容灾实例的数据同步时延，单位为秒（s）。当容灾实例与主实例的同步时延超过该值时，将不触发容灾倒换。默认情况下不进行时延判断。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
   
#### 请求示例
- 默认查询50个实例容灾倒换配置。
  ```
  GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings
  ```
  
- 查询实例容灾倒换配置。
  ```
  GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings?offset=0&limit=50&instance_id=d74162b942604190b991d1c39772a66ain06&instance_id=e74162b942604190b991d1c39772a66ain06
  ```
  
 
#### 响应示例
**状态码： 200**
Success.
```
{  
    "total_count" : 4, 
    "disaster_recovery_settings" : [ {  
        "instance_id" : "d74162b942604190b991d1c39772a66ain06",  
        "switchover_ratio" : 50
    }, {  
        "instance_id" : "e74162b942604190b991d1c39772a66ain06",   
        "switchover_ratio" : 100 
    }, {    
        "instance_id" : "d863b72d8d05457b93fb519cefe8278din06",  
        "switchover_ratio" : 60,  
        "sync_delay" : 300000  
    }, {     
       "instance_id" : "6f64151731604cad99fb97c449158758in06",  
       "switchover_ratio" : 80,  
       "sync_delay" : 600000  
    } ] 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
