
# 查询集群均衡设置-QueryingClusterBalancingSettings
#### 功能介绍
查询DDS集群的数据均衡设置，包括均衡开关和均衡活动时间窗的设置。其中，均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。
#### 接口约束
冻结实例不支持该操作。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ShowShardingBalancer)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                              | 别名                    | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:getShardingBalancer | read | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:instance:balancer | -      |
     
  
 
#### URI
- URI格式 GET /v3/{project_id}/instances/{instance_id}/balancer
  
 
表1路径参数 
| 名称          | 是否必选 | 类型     | IN   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|:---|
| project_id  | 是    | string | path | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                |
| instance_id | 是    | string | path | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 名称           | 是否必选 | 类型     | IN     | 描述                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|:---|
| X-Auth-Token | 是    | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
表3查询集群均衡设置响应消息 
| 名称            | 参数类型    | 是否必选 | 描述                                                   |
|:---|:---|:---|:---|
| is_open       | Boolean | 是    | 集群均衡是否打开。                                            |
| active_window | Object  | 否    | 活动时间窗设置。请参见[表4]。 |
   
 表4活动时间窗响应消息 
| 名称         | 参数类型   | 是否必选 | 描述         |
|:---|:---|:---|:---|
| start_time | String | 否    | 活动时间窗开始时间。 |
| stop_time  | String | 否    | 活动时间窗结束时间。 |
   
#### 请求示例
```
https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer
```
#### 响应示例
```
{
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}
```
#### SDK
单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
