文档

CreateShardingDBInstance - 创建或克隆分片集群实例

创建或者克隆MongoDB分片集群实例。

接口说明

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

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:CreateShardingDBInstanceWrite
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/*

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
ZoneIdstring

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

cn-hangzhou-g
Enginestring

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

MongoDB
EngineVersionstring

数据库版本号,取值:

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

    实例名称,取值说明:

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

    实例的 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 地址都可以访问实例的数据库,属于高危设置,请谨慎设置。
  • 192.168.xx.xx,192.168.xx.xx
    AccountPasswordstring

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

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

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

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

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

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

    说明 ChargeType 参数值为 PrePaid 时,该参数可用且为必填参数。
    1
    NetworkTypestring

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

    VPC:专有网络。

    VPC
    VpcIdstring

    专有网络(VPC)ID。

    vpc-bp1n3i15v90el48nx****
    VSwitchIdstring

    虚拟交换机 ID。

    vsw-bp1vj604nj5a9zz74****
    SrcDBInstanceIdstring

    源实例 ID。

    说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置 RestoreTime 参数。
    dds-bp11483712c1****
    RestoreTimestring

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

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

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

    ETnLKlblzczshOTUbOCz****
    StorageEnginestring

    实例的存储引擎,取值固定为 WiredTiger

    说明
  • 调用本接口克隆实例时,该参数需和源实例保持一致。
  • 关于存储引擎与版本的选择约束,请参见版本与存储引擎
  • WiredTiger
    AutoRenewstring

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

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

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

    • mongodb:MongoDB 协议。
    • dynamodb:DynamoDB 协议。
    mongodb
    Mongosobject []

    Mongos 节点信息。

    Classstring

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

    说明
  • 参数名中的 N 代表传入第几个 Mongos 节点的规格。例如,Mongos.2.Class表示传入第二个 Mongos 节点的规格。
  • N 的取值范围为 2~32
  • mdb.shard.2x.xlarge.d
    ReplicaSetobject []

    Shard 节点的信息。

    Classstring

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

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

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

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

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

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

    说明 参数名中的 N 代表设置第几个 Shard 节点中的只读节点个数。例如,ReplicaSet.2.ReadonlyReplicas表示设置第二个 Shard 节点的只读节点个数。
    0
    ConfigServerobject []

    ConfigServer 节点的信息。

    Classstring

    ConfigServer 的规格,取值说明:

    • mdb.shard.2x.xlarge.d:4 核 8 GB(独享型),仅支持 4.4 及以上版本的实例。
    • dds.cs.mid:1 核 2 GB(通用型),仅支持 4.2 及以下版本的实例。
    mdb.shard.2x.xlarge.d
    Storageinteger

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

    说明 具体取值受实例规格约束,取值详情请参见分片集群实例规格表
    20
    ResourceGroupIdstring

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

    rg-acfmyiu4ekp****
    SecondaryZoneIdstring

    配置备可用区 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时,该参数可用且为必填参数。
  • cn-hangzhou-h
    HiddenZoneIdstring

    配置备可用区 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 相同。
  • 分片集群实例的多可用区部署策略,具体请参见创建多可用区分片集群实例
  • cn-hangzhou-i
    StorageTypestring

    存储类型,取值说明:

    • cloud_essd1:ESSD PL1 云盘。
    • cloud_essd2:ESSD PL2 云盘。
    • cloud_essd3:ESSD PL3 云盘。
    • local_ssd:SSD 本地盘。
    说明
  • 4.4 及以上版本实例只支持云盘,不填写默认选择cloud_essd1
  • 4.2 及以下版本实例只支持本地盘,不填写默认选择local_ssd
  • cloud_essd1
    GlobalSecurityGroupIdsstring

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

    g-qxieqf40xjst1ngpr3jz
    Tagobject []

    用户自定义标签。

    Keystring

    标签的键。

    说明
  • N 表示传入第几个标签的键。例如:Tag.1.Key表示传入第一个标签的键;Tag.2.Key表示传入第二个标签的键。
  • testdatabase
    Valuestring

    标签的值。

    说明 N 表示传入第几个标签的值。例如:Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。
    apitest
    Encryptedboolean

    是否开启云盘加密

    true
    EncryptionKeystring

    自定义密钥 ID。

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    ProvisionedIopslong

    预配置 IOPS

    1960

    返回参数

    名称类型描述示例值
    object

    返回信息。

    RequestIdstring

    请求 ID。

    D8F1D721-6439-4257-A89C-F1E8E9C9****
    DBInstanceIdstring

    实例 ID。

    dds-bp114f14849d****
    OrderIdstring

    订单 ID。

    21010996721****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    400SecurityRisk.AuthVerificationwe 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.
    400InvaliadParameter.ShardsCount.LessThanSrcThe specified number of shards is less than that of source instance.
    400ORDER.ACCOUNT_INFORMATION_INCOMPLETEYour information is incomplete. Complete your information before ordering.
    400InvalidRegion.FormatSpecified Region is not valid.
    400Zone.ClosedThe specified zone is closed.
    400TokenServiceErrorThe request token is duplicated.
    400InvalidParamParam not valid.
    400InvalidEngineVersion.MalformedSpecified engine version is not valid.
    400InvalidParameters.FormatSpecified parameters is not valid.
    403InvalidBackupLogStatusCurrent backup log enable status does not support this operation.
    500VpcServiceErrorInvoke vpc service error.

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

    变更历史

    变更时间变更内容概要操作
    2023-08-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:ProvisionedIops
    2023-08-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:Tag
    2023-06-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:Encrypted
      新增入参:EncryptionKey
    2022-10-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:StorageType
    2021-12-27OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    2021-12-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:ResourceGroupId
    • 本页导读 (1)
    文档反馈