# 创建集群的Shard/Config IP-CreatingShardorConfigIPAddressesofaClusterInstance
#### 接口说明
创建集群的Shard/Config IP。
#### 约束说明
- 冻结实例不支持该操作。
- 针对IPv6子网创建的实例不支持该操作。
- 针对已打开IP开关的组，在开关打开之后需要用户手动重启对应组才能生效。
- 该功能打开后暂不支持关闭。
 
#### 调试
您可以在[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:createIp | write | -           | -   | -  | -      |
     
  
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/create-ip
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/create-ip
  
 
表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参数说明 
| 名称        | 参数类型   | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| type      | String | 是    | **参数解释：** 集群实例类型。 **约束限制：** - 扩容Shard组时，取值为"shard"。  - 扩容Config组时，取值为"config"。   **取值范围：** 不涉及。 **默认取值：** 不涉及。                                       |
| target_id | String | 否    | **参数解释：** Shard组ID 。 **约束限制：** 注意： - 第一次添加Shard/Config IP时，该参数不传。  - 对于已经添加过Shard IP的实例，需要传入该参数为新扩容的Shard组添加IP。   **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| password  | String | 是    | **参数解释：** 打开集群开关设置的密码。 **约束限制：** 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 注意： 该密码暂不支持修改，请谨慎操作。 **取值范围：** 长度为8\~32位，必须是大写字母（A\~Z）、小写字母（a\~z）、数字（0\~9）、特殊字符\~!@#%\^\*-_=+?任意3种类型的组合。 **默认取值：** 不涉及。                                                     |
   
#### 请求示例
- 创建集群实例的Config组IP
  ```
  POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip
  {
  "type" : "config",
  "password" : "******"
  }
  ```
  

- 首次创建集群实例的Shard组IP
  ```
  POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip
  {
  "type" : "shard",
  "password" : "******"
  }
  ```
  

- 已经添加过Shard组IP的实例，开启新扩容的Shard组IP
  ```
  POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip
  {
  "type" : "shard",
  "target_id" : "91bac9f23ead42e19013333e05f44829gr02",
  "password" : "******"
  }
  ```
  
 
#### 响应消息
- 参数说明 无。
  
- 响应示例 无。
  
 
#### 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)。