文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/实例管理/创建集群的Shard/Config IP
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

创建集群的Shard/Config IP

接口说明

创建集群的Shard/Config IP。

约束说明

  • 冻结实例不支持该操作。
  • 针对Ipv6子网创建的实例不支持该操作。
  • 针对已打开IP开关的组，在开关打开之后需要用户手动重启对应组才能生效。
  • 支持3.4及以上版本的社区版集群实例。
  • 该功能打开后暂不支持关闭。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip

  • URI样例

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 参数说明

名称

参数类型

是否必选

描述

type

String

是

集群实例类型。

  • 申请Shard组IP时，取值为“shard”，同时为目标Shard组自动创建一个只读用户sharduser（每个shard组单独一个同名只读用户）。
  • 申请Config组IP时，取值为“config”, 同时为Config组自动创建一个只读用户csuser。

target_id

String

否

Shard组ID。

注意：
  • 首次申请Shard/Config IP时，该参数不传，为当前所有Shard组以同样密码申请IP并创建只读用户sharduser。
  • 扩容节点场景下，因为没有其他Shard组的sharduser用户密码记录，不会自动为新Shard组申请IP和只读用户sharduser，如需新扩容的Shard组也申请IP，需要调用此API并将target_id(组ID)传入。
  • 对同一实例多次调用此API场景下，password字段无需一致（每个shard组单独一个同名只读用户）。

password

String

是

打开集群开关设置的密码。

  • 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?()$的组合。
  • 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。
注意：

该密码可通过”修改数据库用户密码”api修改，调用”修改数据库用户密码”api后，在上述target_id传入场景下，所有shard的只读用户sharduser密码一致。

  • 请求示例
    config: 
    {
"type" : "config",
"password" : "******"
}
    shard: 
    {
"type" : "shard",
"password" : "******"
}
    shard: 
    {
"type" : "shard",
"target_id" : "91bac9f23ead42e19013333e05f44829gr02",
"password" : "******"
}

响应参数

  • 参数说明

    无。

  • 响应示例 
    {}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：实例管理