调用CreateShardingDBInstance接口创建或克隆云数据库MongoDB分片集群实例。

  • 请确保在使用该接口前,已充分了解云数据库MongoDB的收费方式和价格
  • 关于云数据库MongoDB实例的规格,请参见实例规格表
  • 如果需要创建单节点实例和副本集实例,您可以通过调用CreateDBInstance接口创建。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

地域ID,您可以通过调用DescribeRegions接口查询地域ID。

Action String CreateShardingDBInstance

系统规定参数。取值:CreateShardingDBInstance

ZoneId String cn-hangzhou-g

可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。

Engine String MongoDB

数据库引擎。固定取值:MongoDB

EngineVersion String 4.4

数据库版本号,取值:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
    说明
    • 关于存储引擎与版本的选择约束,请参见版本与存储引擎
    • 调用本接口克隆实例时,该参数值需和源实例保持一致。
DBInstanceDescription String test

实例名称,取值说明:

  • 以中文、英文字母开头。
  • 可以包含数字、中文、英文、下划线(_)和短横线(-)。
  • 长度为2~256个字符。
SecurityIPList String 192.168.xx.xx,192.168.xx.xx

实例的IP白名单,多个IP地址请用英文逗号(,)分隔,不可重复。支持如下三种格式:

  • 0.0.0.0/0
  • IP地址形式,例如:10.23.12.24。
  • CIDR形式,例如:10.23.12.0/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
    说明
    • 每个实例最多添加1000个IP或IP段,即所有IP白名单分组内的IP或IP段总和不能超过1000。
    • 0.0.0.0/0表示任何IP地址都可以访问实例的数据库,属于高危设置,请谨慎设置。
AccountPassword String 123456Aa

root账号的密码,取值说明:

  • 由大写字母、小写字母、数字、特殊字符中的至少三种组成。
  • !#$%^&*()_+-=为特殊字符。
  • 长度为8~32个字符。
ChargeType String PrePaid

实例的付费类型,取值说明:

  • PostPaid:默认值,后付费(按量付费)。
  • PrePaid:预付费(包年包月)。
说明 当该参数的值为PrePaid时,您还需要配置Period参数。
Period Integer 1

实例的购买时长,单位为月。

取值范围:1~9(整数)、12243660

说明ChargeType参数值为PrePaid时,该参数可用且为必填参数。
NetworkType String VPC

实例的网络类型,取值说明:

VPC:专有网络。

VpcId String vpc-bp1n3i15v90el48nx****

专有网络(VPC)ID。

VSwitchId String vsw-bp1vj604nj5a9zz74****

虚拟交换机ID。

SrcDBInstanceId String dds-bp11483712c1****

源实例ID。

说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置RestoreTime参数。
RestoreTime String 2022-03-08T02:30:25Z

选择要恢复的时间点,您可以配置7天内的任意时间点。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
ClientToken String ETnLKlblzczshOTUbOCz****

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

StorageEngine String WiredTiger

实例的存储引擎,取值:

  • WiredTiger(默认值)
  • RocksDB
  • TerarkDB
    说明
    • 调用本接口克隆实例时,该参数需和源实例保持一致。
    • 关于存储引擎与版本的选择约束,请参见版本与存储引擎
AutoRenew String true

实例是否自动续费,取值说明:

  • true:自动续费。
  • false:默认值,不自动续费,即手动续费。
说明ChargeType参数值为PrePaid时,该参数可用且为可选参数。
ProtocolType String mongodb

访问协议的类型,取值说明:

  • mongodb:MongoDB协议。
  • dynamodb:DynamoDB协议。
Mongos.N.Class String mdb.shard.2x.xlarge.d

Mongos节点的规格,取值详情请参见分片集群实例规格表

说明
  • 参数名中的N代表传入第几个Mongos节点的规格。例如,Mongos.2.Class表示传入第二个Mongos节点的规格。
  • N的取值范围为2~32
ReplicaSet.N.Class String dds.shard.standard

Shard节点的规格,取值详情请参见分片集群实例规格表

说明
  • 参数名中的N代表传入第几个Shard节点的规格。例如,ReplicaSet.2.Class表示传入第二个Shard节点的规格。
  • N的取值范围为2~32
ReplicaSet.N.Storage Integer 10

Shard节点的存储空间,单位为GB。

取值范围:10~2000

说明
  • 步长为10 GB。
  • 具体取值受实例规格约束,取值详情请参见分片集群实例规格表
  • 参数名中的N代表的是传入第几个Shard节点的存储空间,例如:ReplicaSet.2.Storage表示传入第二个Shard节点的存储空间。
ReplicaSet.N.ReadonlyReplicas Integer 0

设置Shard节点的只读节点个数。

取值范围:0~5(整数),默认值为0

说明 参数名中的N代表设置第几个Shard节点中的只读节点个数。例如,ReplicaSet.2.ReadonlyReplicas表示设置第二个Shard节点的只读节点个数。
ConfigServer.N.Class String mdb.shard.2x.xlarge.d

CongfigServer的规格,取值说明:

  • mdb.shard.2x.xlarge.d:4核 8 GB(独享型),仅支持4.4和5.0版本的实例。
  • dds.cs.mid:1核 2 GB(通用型),仅支持3.4、4.0和4.2版本的实例。
ConfigServer.N.Storage Integer 20

CongfigServer的存储空间,单位为GB。

固定取值:20

ResourceGroupId String rg-acfmyiu4ekp****

资源组ID,资源组详情请参见查看资源组基本信息

SecondaryZoneId String cn-hangzhou-h

配置备可用区1,实现多可用区部署。取值说明:

  • cn-hangzhou-g:杭州可用区G。
  • cn-hangzhou-h:杭州可用区H。
  • cn-hangzhou-i:杭州可用区I。
  • cn-hongkong-b:中国香港可用区B。
  • cn-hongkong-c:中国香港可用区C。
  • cn-hongkong-d:中国香港可用区D。
  • cn-wulanchabu-a:乌兰察布可用区A。
  • cn-wulanchabu-b:乌兰察布可用区B。
  • cn-wulanchabu-c:乌兰察布可用区C。
  • ap-southeast-1a:新加坡可用区A。
  • ap-southeast-1b:新加坡可用区B。
  • ap-southeast-1c:新加坡可用区C。
  • ap-southeast-5a:雅加达可用区A。
  • ap-southeast-5b:雅加达可用区B。
  • ap-southeast-5c:雅加达可用区C。
  • eu-central-1a:法兰克福可用区A。
  • eu-central-1b:法兰克福可用区B。
  • eu-central-1c:法兰克福可用区C。
    说明
    • EngineVersion取值为4.45.0时,该参数可用且为必填参数。
    • 该参数值不能与ZoneIdHiddenZoneId相同。
    • 分片集群实例的多可用区部署策略,具体请参见创建多可用区分片集群实例
HiddenZoneId String cn-hangzhou-i

配置备可用区2,实现多可用区部署。取值说明:

  • cn-hangzhou-g:杭州可用区G。
  • cn-hangzhou-h:杭州可用区H。
  • cn-hangzhou-i:杭州可用区I。
  • cn-hongkong-b:中国香港可用区B。
  • cn-hongkong-c:中国香港可用区C。
  • cn-hongkong-d:中国香港可用区D。
  • cn-wulanchabu-a:乌兰察布可用区A。
  • cn-wulanchabu-b:乌兰察布可用区B。
  • cn-wulanchabu-c:乌兰察布可用区C。
  • ap-southeast-1a:新加坡可用区A。
  • ap-southeast-1b:新加坡可用区B。
  • ap-southeast-1c:新加坡可用区C。
  • ap-southeast-5a:雅加达可用区A。
  • ap-southeast-5b:雅加达可用区B。
  • ap-southeast-5c:雅加达可用区C。
  • eu-central-1a:法兰克福可用区A。
  • eu-central-1b:法兰克福可用区B。
  • eu-central-1c:法兰克福可用区C。
    说明
    • EngineVersion取值为4.45.0时,该参数可用且为必填参数。
    • 该参数值不能与ZoneIdSecondaryZoneId相同。
    • 分片集群实例的多可用区部署策略,具体请参见创建多可用区分片集群实例

返回数据

名称 类型 示例值 描述
RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9****

请求ID。

DBInstanceId String dds-bp114f14849d****

实例ID。

OrderId String 21010996721****

订单ID。

示例

请求示例

http(s)://[mongodb.aliyuncs.com/?Action=CreateShardingDBInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp1n3i15v90el48nx****
&VSwitchId=vsw-bp1vj604nj5a9zz74****
&ClientToken=ETnLKlblzczshOTUbOCz****
&StorageEngine=WiredTiger
&AutoRenew=true
&ProtocolType=mongodb
&Mongos=[{"Class":"mdb.shard.2x.xlarge.d"}]
&ReplicaSet=[{"Class":"dds.shard.standard","Storage":10,"ReadonlyReplicas":0}]
&ConfigServer=[{"Class":"mdb.shard.2x.xlarge.d","Storage":20}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateShardingDBInstanceResponse>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
    <DBInstanceId>dds-bp114f14849d****</DBInstanceId>
    <OrderId>21010996721****</OrderId>
</CreateShardingDBInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "DBInstanceId" : "dds-bp114f14849d****",
  "OrderId" : "21010996721****"
}

错误码

访问错误中心查看更多错误码。