You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

CreateDBInstance

最近更新时间：2024.05.18 16:28:45

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

我的收藏

调用 CreateDBInstance 接口创建 MongoDB 实例。

请求类型

异步请求。

请求参数

参数
类型
是否必选
示例值
描述
ZoneId
String
是
cn-beijing-a

实例所在可用区的 ID。

说明

  • 您可以调用 DescribeAvailabilityZones 接口查看当前账号下所有可创建 MongoDB 实例的可用区信息，包括可用区 ID。
  • 如果您需要为新建的实例部署多可用区，您可以同时传入三个可用区 ID，多个可用区之间用英文逗号（,）隔开。默认第一个传入的可用区为主可用区，后面传入的两个可用区为备可用区。更多详情，请参见多可用区同城容灾解决方案。
VpcId
String
是
vpc-rs5811nceqyov0x58x4****

私有网络 ID。

说明

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

SubnetId
String
是
subnet-274c1ohtlim0w7fap8sna****

子网 ID。

说明

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

DBEngine
String
否
MongoDB
数据库引擎。取值固定为 MongoDB。
DBEngineVersion
String
否
MongoDB_4_0

数据库引擎版本，取值范围如下：

  • MongoDB_4_0（默认）：MongoDB 4.0 版本。
  • MongoDB_5_0：MongoDB 5.0 版本。
InstanceType
String
否
ReplicaSet

MongoDB 的实例类型，取值范围如下：

  • ReplicaSet（默认）：副本集。
  • ShardedCluster：分片集群 。
NodeSpec
String
是
mongo.1c2g

实例的规格码。其中：

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

说明

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

NodeNumber
Integer
否
3

节点数量，其中：

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

说明

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

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 实例的规格信息，包括不同节点支持的存储空间规格。
SuperAccountName
String
否
root
数据库账号名称。当前仅支持在创建实例时设置超级管理员账号，账号名称固定为 root。
SuperAccountPassword
String
否
Password123

root 账号的密码。密码需同时满足如下条件：

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

说明

  • 若该参数留空，表示不为 root 账号设置密码，此时系统会自动为 root 账号生成一个密码来保证实例访问安全性。
  • 您也可以在实例创建后，通过 ResetDBAccount 接口来修改 root 账号的密码。
InstanceName
String
否
test_mongo

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

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

说明

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

实例计费类型，取值范围如下：

  • PostPaid（默认）：按量计费（也称后付费）。
  • Prepaid：包年包月（也称预付费）。
AutoRenew
Boolean
否
false

是否开启自动续费，取值范围如下：

  • false（默认）：不开启自动续费。
  • true：开启自动续费。

说明

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

PeriodUnit
String
否
Year

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

  • Year：包年。
  • Month：包月。

说明

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

Period
Integer
否
1

包年包月实例的购买时长，其中：

  • 当 PeriodUnit 为 Year 时，Period 取值为 1~3。
  • 当 PeriodUnit 为 Month 时，Period 取值为 1~9。

说明

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

ProjectName
String
否
default

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

说明

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

Tags
Object[]
否

需要绑定的标签键和标签值数组对象。

说明

  • 支持一次传入多组标签键值对像，多组标签键值对像间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。
  • 标签键值需满足设置规则，具体规则请参见标签设置规则。
AllowListIds
String[]
否
[ "acl-cq014ioqkm9zt5j****", "acl-cq015pp15v8buvl****" ]

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

说明

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

返回参数

参数
类型
示例值
描述
InstanceId
String
mongo-replica-e405f8e2****
新建实例的实例 ID。
OrderNO
String
Order707662635934417****
订单 ID。

示例

请求示例 1

创建 1 个副本集实例（默认包含 3 个节点），配置如下：

  • 节点规格： 2 核 4 GiB。
  • 存储空间： 30 GiB。
  • 绑定 instancetype 和 chargetype 两个标签。
  • 使用多可用区部署方式，其中可用区 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-guanzhou/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

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

请求示例 2

创建 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,
    "Tags":[
        {
            "Key":"instancetype",
            "Value":"shard"
        },
        {
            "Key":"chargetype",
            "Value":"postpaid"
        }
    ]
}

返回示例 2

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