
# 删除集群的Shard/Config IP-DeletingShardorConfigIPAddressesofaClusterInstance
#### 接口说明
删除集群的Shard/Config IP。
#### 约束说明
- 冻结实例不支持该操作。
- 在删除期间，对应节点的IP不可访问。
- 在删除期间，对应shard或config的节点会进行重启，文档数据库实例重启过程中将不可用，请谨慎操作。
- 支持版本为4.0及以上的社区版集群实例。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=CreateIp)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                   | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:deleteIp | write | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 DELETE /v3/{project_id}/instances/{instance_id}/ip
  表1路径参数 
  | 名称          | 参数类型   | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  |:---|:---|:---|:---|
  | 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请求Header参数 
  | 名称           | 是否必选 | 类型     | IN     | 描述                                                                                                                                                                                                                                                                                                                                                                     |
  |:---|:---|:---|:---|:---|
  | X-Auth-Token | 是    | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  请求Body参数
  
  | 名称   | 参数类型   | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  |:---|:---|:---|:---|
  | type | String | 是    | **参数解释：** 需要删除IP的组类型。 **约束限制：** 不涉及。 **取值范围：** - shard：表示删除所有Shard组IP。  - config：表示删除Config组IP。   **默认取值：** 不涉及。 |
     
  
 
#### 请求示例
- 删除实例520c58ba00a3497e97ce0b9604874dd6in02的config IP：
  ```
  DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip 
    
  { 
     "type" : "config" 
  }
  ```
  

- 删除实例520c58ba00a3497e97ce0b9604874dd6in02所有的shard IP：
  ```
  DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip 
    
  { 
     "type" : "shard" 
  }
  ```
  
 
#### 响应消息
**状态码：202**
表3响应Body参数 
| 参数     | 参数类型   | 是否必选 | 描述                                                                                                                          |
|:---|:---|:---|:---|
| job_id | String | 是    | **参数解释：** 任务ID。 **取值范围：** 不涉及。 |
   
#### 响应示例
无。
#### 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)。
