全部产品
Search
文档中心

云数据库 MongoDB:CreateDBInstance - 创建或克隆副本集实例

更新时间:Jan 17, 2023

创建或克隆云数据库MongoDB副本集实例。

接口说明

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

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

如需创建分片集群实例,您可以通过调用CreateShardingDBInstance接口创建。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
RegionId string

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

说明 调用本接口克隆实例或者回收站恢复实例时,该参数值需和源实例保持一致。
cn-hangzhou
ClientToken string

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

ETnLKlblzczshOTUbOCz****
ZoneId string

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

cn-hangzhou-g
Engine string

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

MongoDB
EngineVersion string

数据库版本号,取值:

  • 6.0
  • 5.0
  • 4.4
  • 4.2
  • 4.0
说明 调用本接口克隆实例或者回收站恢复实例时,该参数值需和源实例保持一致。
4.4
DBInstanceClass string

实例规格,您可以通过调用DescribeAvailableResource接口查询实例规格。

dds.mongo.standard
DBInstanceStorage integer

实例存储空间,单位:GB。

具体取值受实例规格约束,详情请参见副本集实例规格表

10
DBInstanceDescription string

实例名称,取值说明:

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

实例的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
    AccountPassword string

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

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

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

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

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

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

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

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

    VPC:专有网络。

    VPC
    VpcId string

    专有网络(VPC)ID。

    vpc-bp175iuvg8nxqraf2****
    VSwitchId string

    虚拟交换机ID。

    vsw-bp1gzt31twhlo0sa5****
    SrcDBInstanceId string

    源实例ID。

    说明 调用本接口克隆实例时,您需要配置该参数,同时还需要配置BackupIdRestoreTime参数。调用本接口进行回收站恢复时,只需要传入该参数,无需配置BackupIdRestoreTime
    dds-bp1ee12ad351****
    BackupId string

    备份点ID,您可以通过调用DescribeBackups接口查询备份点ID。

    说明 只有调用本接口按备份点克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
    32994****
    RestoreTime string

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

    说明 只有调用本接口按时间点克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
    2022-03-13T12:11:14Z
    BusinessInfo string

    附加参数,业务信息。

    {“ActivityId":"000000000"}
    AutoRenew string

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

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

    数据库名。

    说明 调用本接口克隆实例时,您可以通过配置该参数指定需要克隆的数据库,如果不配置该参数,则克隆实例的所有数据库。
    mongodbtest
    CouponNo string

    优惠码,默认值为youhuiquan_promotion_option_id_for_blank

    youhuiquan_promotion_option_id_for_blank
    StorageEngine string

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

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

    副本集实例的主备节点数,取值:

    • 3(默认值)
    • 5
    • 7
    3
    ReadonlyReplicas string

    副本集实例的只读节点数,取值范围:0~5(整数),默认值为0

    0
    ResourceGroupId string

    资源组ID。

    rg-acfmyiu4ekp****
    ClusterId string

    专属集群ID。

    dhg-2x78****
    StorageType string

    存储类型,取值说明:

    • cloud_essd1:ESSD PL1云盘。
    • cloud_essd2:ESSD PL2云盘。
    • cloud_essd3:ESSD PL3云盘。
    • local_ssd:SSD本地盘。
    cloud_essd1
    SecondaryZoneId string

    配置从节点(Secondary节点)所在的可用区,实现多可用区部署。取值说明:

    • 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参数值相同。
  • cn-hangzhou-h
    HiddenZoneId string

    配置隐藏节点(Hidden节点)所在的可用区,实现多可用区部署。取值说明:

    • 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

    返回参数

    名称 类型 描述 示例值
    object
    RequestId string

    请求ID。

    D8F1D721-6439-4257-A89C-F1E8E9C9****
    DBInstanceId string

    实例ID。

    dds-bp144a7f2db8****
    OrderId string

    订单ID。

    21077576248****

    示例

    正常返回示例

    JSON格式

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

    错误码

    Http 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 MissingParameter Period is mandatory for this action. -
    400 ORDER.ACCOUNT_INFORMATION_INCOMPLETE Your information is incomplete. Complete your information before ordering. -
    400 InvalidClientToken.Malformed Specified parameter ClientToken is not valid. -
    400 InvalidDBInstanceDescription.Malformed Specified parameter DBInstanceDescription is not valid. 节点名称不合法
    400 InvalidSecurityIPListLength.Malformed The quota of security ip exceeds. -
    400 InsufficientBalance Your account does not have enough balance. 支付失败,您可以添加其他支付方式,也可以充值后重试。
    400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded. -
    400 InvalidCapacity.NotFound The Capacity provided does not exist in our records. 实例的存储容量配置错误,请设置为有效范围内的值,单位为MB。
    400 ResourceNotAvailable Resource you requested is not available for finance user. -
    400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. ClientToken参数值已被使用,请输入未使用过的ClientToken参数值。ClientToken由客户端生成,需保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。
    400 InvalidSecurityIPList.Malformed The specified parameter "SecurityIPList" is not valid. -
    400 InvalidSecurityIPList.Duplicate The Security IP address is not in the available range or occupied. -
    400 InvalidSecurityIPListLength.Malformed The quota of security ip exceeds. -
    400 InvalidDBInstanceStorage.ValueNotSupported The specified parameter DBInstanceStorage is not valid. -
    400 InvalidAccountPassword.Malformed Specified parameter AccountPassword is not valid. -
    400 TokenServiceError Duplicate ClientToken request. -
    400 Zone.Closed The specified zone is closed. -
    400 PRICE.ORIGIN_PRICE_ERROR The origin price error. -
    400 NO_AVAILABLE_PAYMENT_METHOD No payment method is specified for your account. We recommend that you add a payment method. -
    400 InvalidEcsImage.NotFound Specified ecs image does not exist. -
    400 SaleValidateNoSpecificCodeFailed Specified Storage or Version or InstanceClass is invalid. -
    400 Trade_Not_Support_Async_Pay Trade not support async pay. -
    403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. 阿里云账号未进行实名认证,请进行实名认证后重试。
    403 RegionUnauthorized There is no authority to create instance in the specified region. -
    403 OperationDenied The resource is out of usage. -
    403 InvalidEngineVersionInRegion.NotAvailable The EngineVersion in the Region is not available. -
    403 InvalidBackupLogStatus Current backup log enable status does not support this operation. -
    403 IncorrectBackupSetState Current backup set state does not support operations. 当前最新备份集未就绪,请稍后重试。
    404 InvalidBackup.NotFound The available backup does not exist in recovery time. -

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