CreateShardingDBInstance_云数据库 MongoDB 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 请确保在使用该接口前,已充分了解云数据库 MongoDB 的收费方式和价格

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

  • 如果需要创建单节点实例和副本集实例,您可以通过调用 CreateDBInstance 接口创建。

流控信息

请求速率为1000/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dds:CreateShardingDBInstance
Create
Instance
acs:dds:{#regionId}:{#accountId}:dbinstance/*

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

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

示例值:cn-hangzhou-g
Enginestring

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

示例值:MongoDB枚举值:MongoDB
EngineVersionstring

数据库版本号,取值:展开详情

示例值:4.4枚举值:3.03.23.44.04.24.45.06.07.0参考取值来源:
    DescribeAvailableEngineVersion
DBInstanceDescriptionstring

实例名称,取值说明:展开详情

示例值:test
SecurityIPListstring

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

示例值:192.168.xx.xx,192.168.xx.xx
AccountPasswordstring

root 账号的密码,取值说明:展开详情

示例值:123456Aa
ChargeTypestring

实例的付费类型,取值说明:展开详情

示例值:PrePaid枚举值:PrePaidPostPaid
Periodinteger<int32>

实例的购买时长,单位为月。展开详情

示例值:1
NetworkTypestring

实例的网络类型,取值说明:展开详情

示例值:VPC枚举值:VPCClassic
VpcIdstring

专有网络(VPC)ID。

示例值:vpc-bp1n3i15v90el48nx****
VSwitchIdstring

虚拟交换机 ID。

示例值:vsw-bp1vj604nj5a9zz74****
SrcDBInstanceIdstring

源实例 ID。展开详情

示例值:dds-bp11483712c1****
RestoreTimestring

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

示例值:2022-03-08T02:30:25Z
ClientTokenstring

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

示例值:ETnLKlblzczshOTUbOCz****
StorageEnginestring

实例的存储引擎,取值固定为 WiredTiger展开详情

示例值:WiredTiger枚举值:WiredTigerRocksDB
AutoRenewstring

实例是否自动续费,取值说明:展开详情

示例值:true
ProtocolTypestring

访问协议的类型,取值说明:展开详情

示例值:mongodb枚举值:mongodbdynamodb
Mongosarray<object>

Mongos 节点信息。

子级条数 <= 32
ReplicaSetarray<object>

Shard 节点的信息。

子级条数 <= 32
ConfigServerarray<object>

ConfigServer 节点的信息。

子级条数 <= 32
ResourceGroupIdstring

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

示例值:rg-acfmyiu4ekp****
SecondaryZoneIdstring

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

示例值:cn-hangzhou-h
HiddenZoneIdstring

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

示例值:cn-hangzhou-i
StorageTypestring

存储类型,取值说明: 展开详情

示例值:cloud_essd1
GlobalSecurityGroupIdsstring

实例的全局 IP 白名单模板,多个 IP 白名单模板请用英文逗号(,)分隔,不可重复。

示例值:g-qxieqf40xjst1ngpr3jz 参考取值来源:
    DescribeGlobalSecurityIPGroup
    CreateGlobalSecurityIPGroup
    ModifyGlobalSecurityIPGroupName
Tagarray<object>

用户自定义标签。

子级条数 <= 21
Encryptedboolean

是否开启云盘加密

示例值:true
EncryptionKeystring

自定义密钥 ID。

示例值:2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx参考取值来源:
    DescribeDBInstanceEncryptionKey
ProvisionedIopsinteger<int64>

预配置 IOPS

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1960
SrcRegionstring

源实例所在区域。展开详情

示例值:cn-beijing
BackupIdstring

集群备份 ID。展开详情

示例值:cb-xxx参考取值来源:
    CreateBackup
    DescribeBackups
RestoreTypestring

备份恢复实例。展开详情

示例值:1枚举值:0123
DestRegionstring

异地备份所在地域。

示例值:cn-hangzhou

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceIdstring

实例 ID。

示例值:dds-bp114f14849d****
OrderIdstring

订单 ID。

示例值:21010996721****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
400
RestoreTypeNotSupported
The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.诊断
403
InvalidBackupLogStatus
Current backup log enable status does not support this operation.诊断
403
ReduceDiskNotSupport
Reduce disk size is not supported in clone/restore.诊断
500
VpcServiceError
Invoke vpc service error.诊断

变更历史

变更时间变更内容概要操作
2025-01-16
变更错误码400
变更错误码403
变更请求参数RestoreType
2024-03-13
变更请求参数EngineVersion
2024-03-13
变更请求参数NetworkType
2023-08-24
新增请求参数ProvisionedIops
2023-08-01
新增请求参数Tag
2023-06-05
新增请求参数Encrypted
新增请求参数EncryptionKey
  • 1
  • 2
  • 10 条/页

相关示例

创建 MongoDB 分片集群并为集群添加节点
2021-02-17