You need to enable JavaScript to run this app.
导航

CreateDBInstance

最近更新时间2023.12.28 17:19:41

首次发布时间2022.04.12 11:06:53

调用 CreateDBInstance 接口创建 MongoDB 实例。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述

ZoneId

String

cn-beijing-a

实例所在可用区的 ID。

说明

  • 您可以调用 DescribeAvailabilityZones 接口查看当前账号下所有可创建 MongoDB 实例的可用区信息,包括可用区 ID。
  • 如果您需要为新建的实例部署多可用区,您可以同时传入三个可用区 ID,多个可用区之间用英文逗号(,)隔开。默认第一个传入的可用区为主可用区,后面传入的两个可用区为备可用区。更多详情,请参见多可用区同城容灾解决方案
DBEngineStringMongoDB数据库引擎。取值固定为 MongoDB

DBEngineVersion

String

MongoDB_4_0

数据库引擎版本,取值范围如下:

  • MongoDB_4_0(默认值):MongoDB 4.0 版本。
  • MongoDB_5_0:MongoDB 5.0 版本。

NodeSpec

String

mongo.1c2g

实例的规格码。其中:

  • 当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。
  • 当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。

说明

您可以调用 DescribeNodeSpecs 接口查看实例规格信息,包括规格码。

NodeNumber

Integer

3

节点数量,其中:

  • 当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。
  • 当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。

说明

当前每个副本集实例和每个 Shard 分片均仅支持 3 个节点,取值固定为3

InstanceType

String

ReplicaSet

MongoDB 的实例类型,取值范围如下:

  • ReplicaSet:副本集(默认)。
  • ShardedCluster:分片集群 。

MongosNodeSpec

String

mongo.mongos.1c2g

分片集群中 Mongos 节点的规格码。

说明

  • 当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数必填。
  • 您可以调用 DescribeNodeSpecs 接口查看分片集群的实例规格信息,包括规格码。

MongosNodeNumber

Integer

2

分片集群中 Mongos 节点的数量。取值范围:2~32。

说明

当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数必填。

ShardNumber

Integer

3

分片集群中 Shard 分片的数量。取值范围:2~32。

说明

当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数必填。

StorageSpaceGB

Integer

100

副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。

说明

  • 若实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,创建成功后整个实例的总容量为单个 Shard 分片的存储空间乘以 Shard 分片数。
  • 您可以调用 DescribeNodeSpecs 接口查看 MongoDB 实例的规格信息,包括不同节点支持的存储空间规格。

ConfigNodeSpec

String

mongo.config.1c2g

分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g

说明

  • 仅当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数生效。
  • 您可以调用 DescribeNodeSpecs 接口查看分片集群的实例规格信息,包括规格码。

ConfigStorageSpaceGB

String

20

分片集群中 ConfigServer 的存储空间,单位:GiB。
取值范围:20~2000,步长为 10,默认值:20。

说明

仅当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数生效。

VpcId

String

vpc-rs5811nceqyov0x58x4****

私有网络 ID。

说明

您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息,包括私有网络 ID。

SubnetId

String

subnet-274c1ohtlim0w7fap8sna****

子网 ID。

说明

您可以调用 DescribeSubnets 接口查询指定私有网络下的子网列表信息,包括子网 ID。

SuperAccountNameStringroot数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root

SuperAccountPassword

String

Password123

root 账号的密码。密码需满足如下条件:

说明

  • 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。
  • 特殊字符包括 !@#$%^&*()_+-=
  • 长度为 8~32 个字符。

InstanceName

String

test_mongo

实例名称。名称需同时满足如下要求:

  • 不能以数字、中划线(-)开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度需为 2~64 个字符。

说明

  • 若该参数不填,实例 ID 默认作为实例名称。
  • 您可以根据需要自定义实例名称,实例名称无唯一性要求。
CountInteger1需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。

ChargeType

String

Prepaid

实例计费类型,取值范围如下:

  • Prepaid:包年包月(也称预付费)。
  • PostPaid(默认):按量计费(也称后付费)。

AutoRenew

Bool

false

是否开启自动续费,取值范围如下:

  • false(默认):不开启自动续费。
  • true:开启自动续费。

说明

ChargeType 取值为 Prepaid 时,该参数必填。

PeriodUnit

String

Year

指定包年包月实例为包年或者包月类型。取值如下:

  • Year:包年。
  • Month:包月。

说明

ChargeType 取值为 Prepaid 时,该参数必填。

Period

Integer

1

包年包月实例的购买时长,其中:

  • PeriodUnitYear 时,Period 取值为 1~3。
  • PeriodUnitMonth 时,Period 取值为 1~9。

说明

ChargeType 取值为 Prepaid 时,该参数必填。

ProjectName

String

default

选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。

说明

项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色对这些资源的权限。更多详情,请参见资源管理

Tags

Array of TagObject

[
{
"Key":"instancetype",
"Value":"shard"
},
{
"Key":"chargetype",
"Value":"prepaid"
}
]

需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情,请参见数据结构

说明

  • 支持一次传入多组标签键值对像,多组标签键值对像间用英文逗号(,)分隔。最多同时传入 20 组标签键值对。
  • 标签键值需满足设置规则,具体规则请参见标签设置规则

AllowListIds

Array of String

[
"acl-cq014ioqkm9zt5j****",
"acl-cq015pp15v8buvl****"
]

白名单 ID 列表。新建实例会被绑定到指定白名单。

说明

  • 您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息,包括白名单 ID 信息。
  • 每个实例最多支持绑定 100 个白名单,每次可最多批量绑定 100 个白名单。

返回数据

名称类型示例值描述
InstanceIdStringmongo-replica-e405f8e2****新建实例的实例 ID。
OrderNOStringOrder707662635934417****订单 ID。

请求示例

  • 创建 1 个副本集实例(默认包含 3 个节点),配置如下:
    • 节点规格: 2 核 4 GiB。
    • 存储空间: 30 GiB。
    • 绑定 instancetypechargetype 两个标签。
    • 使用多可用区部署方式,其中可用区 A 为主可用区,B 和 C 为备可用区。
    • 绑定至 acl-cq014ioqkm9zt5j****acl-cq015pp15v8buvl**** 两个白名单。
    POST https://mongodb.volcengineapi.com/?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1
    Host: mongodb.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-guangzhou/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
    {
        "ZoneId":"cn-guanzhou-a,cn-guanzhou-b,cn-guanzhou-c",
        "NodeSpec":"mongo.2c4g",
        "StorageSpaceGB":30,
        "VpcId":"vpc-13f24t16guqdc3n6nu4k5****",
        "SubnetId":"subnet-rr96lovl7f28v0x58tv****",
        "InstanceName":"api_test_replica",
        "Tags":[
            {
                "Key":"instancetype",
                "Value":"replica"
            },
            {
                "Key":"chargetype",
                "Value":"postpaid"
            }
        ],
        "AllowListIds":[
    		    "acl-cq014ioqkm9zt5j****",
    		    "acl-cq015pp15v8buvl****"
    		]	    
    }
    
  • 创建 1 个分片集群实例,配置如下:
    • Mongos
      • 节点规格:2 核 4GiB。
      • 节点数量:2。
    • Shard
      • 分片数量:2。
      • 每分片节点数:每个分片默认包含 3 个节点。
      • 节点规格:2 核 4GiB。
      • 存储空间:30GiB。
    • ConfigServer
      • 节点规格:2 核 4GiB。
      • 节点数量:默认包含 3 个节点。
      • 存储空间:30GiB。
    • 绑定 instancetype 和 chargetype 两个标签。
    POST https://mongodb.volcengineapi.com/?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1
    Host: mongodb.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
    {
        "ZoneId":"cn-beijing-a",
        "NodeSpec":"mongo.shard.2c4g",
        "StorageSpaceGB":30,
        "VpcId":"vpc-13f24t16guqdc3n6nu4k5****",
        "SubnetId":"subnet-rr96lovl7f28v0x58tv****",
        "InstanceName":"api_test_shard",
        "MongosNodeSpec":"mongo.mongos.1c2g",
        "InstanceType":"ShardedCluster",
        "ShardNumber":2,
        "MongosNodeNumber":2,
        "ConfigNodeSpec":"mongo.config.2c4g",
        "ConfigStorageSpaceGB":30,
        "Tags":[
            {
                "Key":"instancetype",
                "Value":"shard"
            },
            {
                "Key":"chargetype",
                "Value":"postpaid"
            }
        ]
    }
    

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202202241620210102121020921E08****",
        "Action": "CreateDBInstance",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
 "Result": {
     "InstanceId": "mongo-replica-e405f8e2****",
     "OrderNO": "Order707662635934417****"
  }
}