CreateShardingDBInstance - 云数据库 MongoDB

请确保在使用该接口前，已充分了解MongoDB产品的收费方式和价格。

关于云数据库MongoDB实例的规格，请参见实例规格表。

如需创建副本集实例，可通过调用CreateDBInstance接口创建。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateShardingDBInstance	要执行的操作，取值： CreateShardingDBInstance。
EngineVersion	String	是	4.0	数据库版本号，取值： 3.4 4.0 4.2 说明关于存储引擎与版本的选择约束请参见版本与存储引擎。调用本接口用于克隆实例时，该值必须与源实例保持一致。
Engine	String	是	MongoDB	数据库引擎，取值：MongoDB。
RegionId	String	是	cn-hangzhou	地域ID，您可以可调用DescribeRegions查询可用的地域，使用此参数指定实例创建的地域。
AccountPassword	String	否	Alitest!159	root账号的密码。密码由大写字母、小写字母、数字、特殊字符中的至少三种组成，特殊字符为`!#$%^&*()_+-=` 密码长度为8-32位。
ZoneId	String	否	cn-hangzhou-b	可用区ID，您可以通过DescribeRegions查询可用的可用区，使用此参数指定实例创建的可用区。
Mongos.N.Class	String	否	dds.mongos.standard	Mongos节点的规格，取值详情请参见实例规格表。取值范围：2~32。参数名中的N代表的是传入第几个Mongos节点的规格，例如：Mongos.2.Class表示传入第二个Mongos节点规格。
ReplicaSet.N.Class	String	否	dds.shard.standard	Shard节点的规格，取值详情请参见实例规格表。取值范围：2~32。参数名中的N代表的是传入第几个Shard节点的规格，例如：ReplicaSet.2.Class表示传入第二个Shard节点规格。
ReplicaSet.N.Storage	Integer	否	20	Shard节点的存储空间。具体取值受实例规格约束，详情请参见实例规格表。取值范围：10~2000，单位为GB。每10GB递增。参数名中的N代表的是传入第几个Shard节点的存储空间，例如：ReplicaSet.2.Storage表示传入第二个Shard节点的存储空间。
ConfigServer.N.Class	String	否	dds.cs.mid	CongfigServer的规格，取值：dds.cs.mid。说明规格固定为1核2GB规格，数量固定为1个，例如：传入ConfigServer.1.Class参数，取值为dds.cs.mid。
ConfigServer.N.Storage	Integer	否	20	CongfigServer的存储空间，取值：20。说明存储空间取值固定为20GB。传入ConfigServer.1.Storage参数，取值为20。
DBInstanceDescription	String	否	测试数据库1	实例名称，长度为2~256个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。
SecurityIPList	String	否	10.23.12.24/24	实例的IP白名单，以逗号隔开，不可重复，最多1000个IP。支持格式：%，0.0.0.0/0，10.23.12.24（IP）或者10.23.12.24/24（CIDR模式，无类域间路由，/24表示地址前缀的长度，范围为1~32）。说明 %和0.0.0.0/0表示任何IP地址都可以访问实例的数据库，属于高危设置，请谨慎设置。
ChargeType	String	否	PrePaid	实例的付费类型，取值： PostPaid：后付费（按量付费）。 PrePaid：预付费（包年包月）。默认付费类型为按量付费。说明当本参数值为PrePaid时，还需要传入Period参数。
Period	Integer	否	1	实例的购买时长，单位为月。取值范围为：1~9，12，24，36。说明当ChargeType参数值为PrePaid时，本参数才可用且必须传入。
NetworkType	String	否	VPC	实例的网络类型。默认创建经典网络类型的实例。 Classic：经典网络。 VPC：专有网络。说明当本参数值为VPC时，还需要传入VpcId参数和VSwitchId参数。
VpcId	String	否	vpc-bpxxxxxxxx	专有网络（VPC）ID。说明当NetworkType参数值为VPC时，本参数才可用。
VSwitchId	String	否	vsw-bpxxxxxxxx	虚拟交换机ID。说明当NetworkType参数值为VPC时，本参数才可用。
SrcDBInstanceId	String	否	dds-bpxxxxxxxx	源实例ID，只有调用本接口用于克隆实例时才能传入该参数，且必须和RestoreTime参数一同传入。
RestoreTime	String	否	2019-03-08T02:30:25Z	克隆实例时所恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。只有调用本接口用于克隆实例时才能传入该参数，且必须和SrcDBInstanceId参数一同传入。说明支持选择7天内的任一时间点进行克隆。
ClientToken	String	否	ETnLKlblzczshOTUbOCzxxxxxxxxxx	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
StorageEngine	String	否	WiredTiger	实例使用的存储引擎，取值为WiredTiger，RocksDB，TerarkDB，默认值为WiredTiger。关于存储引擎与版本的选择约束请参见版本与存储引擎。说明调用本接口用于克隆实例时，该值必须与源实例保持一致。
AutoRenew	String	否	true	设置实例是否自动续费，取值： true：自动续费。 false：不自动续费，即手动续费。默认为手动续费。说明当ChargeType参数值为PrePaid时，本参数才可用。
ProtocolType	String	否	mongodb	访问协议的类型。取值： mongodb：MongoDB协议 dynamodb：DynamoDB协议
ReplicaSet.N.ReadonlyReplicas	Integer	否	5	设置Shard节点的只读节点个数。取值范围：0~5。默认值：0。参数名中的N代表的是设置第几个Shard节点中的只读节点个数。例如：ReplicaSet.2.ReadonlyReplicas表示设置第二个Shard节点的只读节点个数。说明当前仅中国站支持本参数。

返回数据


名称	类型	示例值	描述
DBInstanceId	String	dds-bpxxxxxxxx	实例ID。
OrderId	String	2033xxxxxxxxxxxx	订单ID。
RequestId	String	D8F1D721-6439-4257-A89C-F1E8E9C9623D	请求ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=CreateShardingDBInstance
&Engine=MongoDB
&EngineVersion=4.0
&AccountPassword=Alitest!159
&ZoneId=cn-hangzhou-b
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<CreateDBInstanceResponse>
	  <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
	  <OrderId>2033xxxxxxxxxxxx</OrderId>
	  <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9623D</RequestId>
</CreateDBInstanceResponse>

JSON 格式

{
    "DBInstanceId": "dds-bpxxxxxxxx",
    "OrderId": "2033xxxxxxxxxxxx",
    "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9623D"
}

错误码

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