
# 修改数据库复制集名称-ChangingtheNameoftheReplicaSetintheConnectionAddress
#### 接口说明
修改数据库复制集名称。
![](https://support.huaweicloud.com/api-dds/public_sys-resources/notice_3.0-zh-cn.png)
文档数据库实例在修改数据库复制集名称过程中将不可用，请谨慎操作。
#### 约束说明
- 仅支持副本集实例。
- 实例在创建、规格变更、修改端口、重启等过程中以及状态为非"normal"时，不允许执行该操作。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=UpdateReplSetName)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                               | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:updateReplicaSetName | write | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 PUT /v3/{project_id}/instances/{instance_id}/replica-set/name
  
- URI样例
  https://dds.cn-north-1.myhuaweicloud.com/v3/0d248ca90800d3902f79c014f11df3b8/instances/593416e7c9da4a4c97c6ad5b086b8ddfin02/replica-set/name
  表1请求参数 
  | 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|:---|
  | X-Auth-Token | 是    | String | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                            |
  | project_id   | 是    | String | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                    |
  | instance_id  | 是    | String | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
- 参数说明
  表2请求Body参数 
  | 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|:---|
  | name | 是    | String | **参数解释：** 连接地址复制集名称：实例高可用连接地址的唯一标识。 该参数可以将读请求发送到副本集实例的所有节点。副本集中的所有主机必须具有相同的集名称。 **取值范围：** 字符限制：在3位到128位之间，必须以英文字母开头，区分大小写，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。 |
     
  
 
#### 请求示例
修改数据库复制集名称为replica
```
{ 
   "name" : "replica" 
 }
```
#### 响应消息
- 参数说明 状态码：202
  表3响应Body参数 
  | 参数     | 参数类型   | 说明                                                                                                                            |
  |:---|:---|:---|
  | job_id | String | **参数解释：** 工作流 id。 **取值范围：** 不涉及。 |
     
  状态码：406
  表4响应Body参数 
  | 参数            | 参数类型                                                    | 说明                                                                                                                                                   |
  |:---|:---|:---|
  | ErrorResponse | Array of [表5] objects | **参数解释：** 实例不是副本集或实例状态非"normal"，当前实例不允许此操作。 **取值范围：** 不涉及。 |
     
   表5ErrorResponse 
  | 参数         | 参数类型   | 说明                                                                                                                                       |
  |:---|:---|:---|
  | error_code | String | **参数解释：** 提交任务异常时返回的错误编码。 **取值范围：** 不涉及。 |
  | error_msg  | String | **参数解释：** 提交任务异常时返回的错误描述信息。 **取值范围：** 不涉及。     |
     
  

- 响应示例
  **状态码：202**
  ```
  { 
      "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" 
  }
  ```
  
 
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
