创建或者克隆MongoDB分片集群实例。
接口说明
-
请确保在使用该接口前,已充分了解云数据库MongoDB的收费方式和价格。
-
关于云数据库MongoDB实例的规格,请参见实例规格表。
-
如果需要创建单节点实例和副本集实例,您可以通过调用CreateDBInstance接口创建。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:CreateShardingDBInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID,您可以通过调用DescribeRegions接口查询地域ID。 | cn-hangzhou |
ZoneId | string | 否 | 可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。 | cn-hangzhou-g |
Engine | string | 是 | 数据库引擎。固定取值:MongoDB。 | MongoDB |
EngineVersion | string | 是 | 4.4 | |
DBInstanceDescription | string | 否 | 实例名称,取值说明:
| test |
SecurityIPList | string | 否 | 实例的IP白名单,多个IP地址请用英文逗号(,)分隔,不可重复。支持如下三种格式:
说明
| 192.168.xx.xx,192.168.xx.xx |
AccountPassword | string | 否 | root账号的密码,取值说明:
| 123456Aa |
ChargeType | string | 否 | 实例的付费类型,取值说明:
说明
当该参数的值为PrePaid时,您还需要配置Period参数。
| PrePaid |
Period | integer | 否 | 实例的购买时长,单位为月。 取值范围:1~9(整数)、12、24、36、60。 说明
当ChargeType参数值为PrePaid时,该参数可用且为必填参数。
| 1 |
NetworkType | string | 否 | 实例的网络类型,取值说明: VPC:专有网络。 | VPC |
VpcId | string | 是 | 专有网络(VPC)ID。 | vpc-bp1n3i15v90el48nx**** |
VSwitchId | string | 是 | 虚拟交换机ID。 | vsw-bp1vj604nj5a9zz74**** |
SrcDBInstanceId | string | 否 | 源实例ID。 说明
只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置RestoreTime参数。
| dds-bp11483712c1**** |
RestoreTime | string | 否 | 选择要恢复的时间点,您可以配置7天内的任意时间点。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
| 2022-03-08T02:30:25Z |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 | ETnLKlblzczshOTUbOCz**** |
StorageEngine | string | 否 | 实例的存储引擎,取值固定为WiredTiger。 说明
| WiredTiger |
AutoRenew | string | 否 | 实例是否自动续费,取值说明:
说明
当ChargeType参数值为PrePaid时,该参数可用且为可选参数。
| true |
ProtocolType | string | 否 | 访问协议的类型,取值说明:
| mongodb |
Mongos | object [] | 是 | Mongos节点信息。 | |
Class | string | 是 | Mongos节点的规格,取值详情请参见分片集群实例规格表。 说明
| mdb.shard.2x.xlarge.d |
ReplicaSet | object [] | 是 | Shard节点的信息。 | |
Class | string | 是 | Shard节点的规格,取值详情请参见分片集群实例规格表。 说明
| dds.shard.standard |
Storage | integer | 是 | Shard节点的存储空间,单位为GB。 说明
| 10 |
ReadonlyReplicas | integer | 否 | 设置Shard节点的只读节点个数。 取值范围:0~5(整数),默认值为0。 说明
参数名中的N代表设置第几个Shard节点中的只读节点个数。例如,ReplicaSet.2.ReadonlyReplicas表示设置第二个Shard节点的只读节点个数。
| 0 |
ConfigServer | object [] | 是 | ConfigServer节点的信息。 | |
Class | string | 是 | CongfigServer的规格,取值说明:
| mdb.shard.2x.xlarge.d |
Storage | integer | 是 | CongfigServer的存储空间,单位为GB。 说明
具体取值受实例规格约束,取值详情请参见分片集群实例规格表。
| 20 |
ResourceGroupId | string | 否 | 资源组ID,资源组详情请参见查看资源组基本信息。 | rg-acfmyiu4ekp**** |
SecondaryZoneId | string | 否 | 配置备可用区1,实现多可用区部署。取值说明:
说明
| cn-hangzhou-h |
HiddenZoneId | string | 否 | 配置备可用区2,实现多可用区部署。取值说明:
说明
| cn-hangzhou-i |
StorageType | string | 否 | 存储类型,取值说明:
说明
| cloud_essd1 |
GlobalSecurityGroupIds | string | 否 | 实例的全局IP白名单模板,多个IP白名单模板请用英文逗号(,)分隔,不可重复。 | g-qxieqf40xjst1ngpr3jz |
Tag | object [] | 否 | 用户自定义标签。 | |
Key | string | 否 | 标签的键。 说明
| testdatabase |
Value | string | 否 | 标签的值。 说明
N表示传入第几个标签的值。例如:Tag.1.Value表示传入第一个标签的值**;Tag.2.Value**表示传入第二个标签的值。
| apitest |
Encrypted | boolean | 否 | 是否开启云盘加密 | true |
EncryptionKey | string | 否 | 自定义密钥ID。 | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
ProvisionedIops | long | 否 | 预配置IOPS | 1960 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
"DBInstanceId": "dds-bp114f14849d****",
"OrderId": "21010996721****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | SecurityRisk.AuthVerification | we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton. |
400 | InvaliadParameter.ShardsCount.LessThanSrc | The specified number of shards is less than that of source instance. |
400 | ORDER.ACCOUNT_INFORMATION_INCOMPLETE | Your information is incomplete. Complete your information before ordering. |
400 | InvalidRegion.Format | Specified Region is not valid. |
400 | Zone.Closed | The specified zone is closed. |
400 | TokenServiceError | The request token is duplicated. |
400 | InvalidParam | Param not valid. |
400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. |
400 | InvalidParameters.Format | Specified parameters is not valid. |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. |
500 | VpcServiceError | Invoke vpc service error. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-08-24 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-08-01 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-06-05 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-10-13 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2021-12-27 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2021-12-27 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|