
# 设置集群均衡开关-EnablingorDisablingClusterBalancing
#### 接口说明
设置DDS集群的数据均衡开关。
#### 约束说明
冻结实例不支持该操作。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=SetBalancerSwitch)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                              | 别名                    | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:setShardingBalancer | write | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:instance:balancer | -      |
     
  
 
#### URI
- URI格式 PUT /v3/{project_id}/instances/{instance_id}/balancer/{action}
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/start
  
 
#### 请求消息
参数说明
表1请求参数 
| 名称           | 类型     | IN     | 必选 | 描述                                                                                                                                                                                                                         |
|:---|:---|:---|:---|:---|
| X-Auth-Token | string | header | 是  | 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。                                                                                                                                     |
| 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)"接口创建。 |
| action       | string | path   | 是  | 开启或关闭集群均衡。                                                                                                                                                                                                                 |
   
#### 响应消息
- 参数说明
  表2参数说明 
  | 名称     | 参数类型   | 是否必选 | 描述     |
  |:---|:---|:---|:---|
  | job_id | String | 是    | 工作流ID。 |
     
  

- 响应示例
  ```
  {
      "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
  }
  ```
  
 
#### 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)。
