创建分片集实例

更新时间：2024-06-05

前提条件

创建实例需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

说明

本接口用于创建相同配置的云数据库 DocDB for MongoDB 实例，目前仅支持一次创建一个。
创建预付费方式的实例则需要账户现金余额大于等于实例费用。
创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。

请求结构

POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
{
    "billing":{
        "paymentTiming": paymentTiming,
        "reservation": {
            "reservationLength": reservationLength
        }
    },
    "engineVersion": dbVersion,
    "storageEngine": dbEngine,
    "dbInstanceType": dbInstanceType,
    "mongosCount": mognosCount,
    "mongosCpuCount": mongosCpuCount,
    "mongosMemoryCapacity": mongosMemoryCapacity,
    "shardCount": shardCount,
    "shardCpuCount": shardCount,
    "shardMemoryCapacity": shardMemoryCapacity,
    "shardStorage": shardStorage,
    "shardStorageType": shardStorageType,
    "dbInstanceName": dbName,
    "accountPassword": password,
    "srcDbInstanceId": srcDbInstanceId,
    "backupId": backupId,
    "vpcId": vpcId,
    "subnets":[
        {
            "zoneName": zoneName,
            "subnetId": subnetId
        }
    ],
    "restoreTime": restoreTime,
    "tags":[
        {
            "tagKey": tagKey,
            "tagValue": tagValue
        }
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	是	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串。
billing	Billing	是	RequestBody参数	订单、计费相关参数。结构及取值参考
purchaseCount	Int	否	RequestBody参数	批量创建实例个数, 目前仅支持一次创建一个；默认1。
dbInstanceName	String	否	RequestBody参数	用户自定义实例名，要求： 1）支持大小写字母、数字、汉字以及-_ /.等特殊字符，必须以字母开头； 2）长度限制为1~65； 3) 默认不指定。如果没有指定，则自动随机生成。
storageEngine	String	是	RequestBody参数	存储引擎。取值参考
engineVersion	String	是	RequestBody参数	数据库版本。取值参考
dbInstanceType	String	否	RequestBody参数	实例类型。默认值replica。取值参考
mongosCount	Int	否	RequestBody参数	Mongos组件数量。创建分片集实例该参数必填。取值范围[2,32]
mongosCpuCount	Int	否	RequestBody参数	Mongos组件CPU规格。创建分片集实例该参数必填。取值参考
mongosMemoryCapacity	Int	否	RequestBody参数	Mongos组件内存规格。创建分片集实例该参数必填。取值参考
shardCount	Int	否	RequestBody参数	Shard组件数量。创建分片集实例该参数必填。取值范围[2,32]
shardCpuCount	Int	否	RequestBody参数	Shard组件CPU规格。创建分片集实例该参数必填。取值参考
shardMemoryCapacity	Int	否	RequestBody参数	Shard组件内存规格。创建分片集实例该参数必填。取值参考
shardStorage	Int	否	RequestBody参数	Shard组件存储规格。创建分片集实例该参数必填。取值参考
shardStorageType	String	否	RequestBody参数	shard组件存储类型。默认值CDS_PREMIUM_SSD。取值参考
accountPassword	String	否	RequestBody参数	root账号的密码，为空则产生随机密码。密码须满足8～32位字符，英文、数字和符号必须同时存在，符号仅限!#$%^*()。密码需要加密传输，密码一律采用AES 128位加密算法进行加密，用SK作为密钥，加密后生成的二进制字节流需要转成十六进制，并以字符串的形式传到服务端。步骤如下： byte[] bCiphertext= AES(明文,SK) String strHex = HexStr(bCiphertext)。
srcDbInstanceId	String	否	RequestBody参数	源实例ID。只有调用本接口用于备份恢复实例时需要配置该参数，同时配置backupId参数。
backupId	String	否	RequestBody参数	备份ID。只支持从物理备份创建实例。只有调用本接口用于备份恢复实例时需要配置该参数，同时需要配置srcDbInstanceId参数
vpcId	String	否	RequestBody参数	如果不提供，则选择默认vpc。可通过调用查询VPC列表接口查询可用的VPC。
subnets	List SubnetModel	否	RequestBody参数	如果不提供，则选择默认子网。当需要创建多可用区分片集实例时，需填写3个可用区子网信息。可通过调用查询可用区列表接口查询可用区列表。
restoreTime	string	否	RequestBody参数	将实例恢复到该时间点，格式为GMT类型字符串"yyyy-MM-ddTHH:mm:ssZ"，该可恢复时间的范围可以通过getRecovableTimeRange接口获取，该参数在srcDbInstanceId存在的时候才可用（此时不需要backupId参数）
resGroupId	String	否	RequestBody参数	资源组ID
tags	List TagModel	否	RequestBody参数	指定新创建实例的标签

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
dbInstanceSimpleModels	List dbInstanceSimpleModel	创建的实例信息

请求示例

POST /v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: mongodb.bj.baidubce.com
ContentType: application/json    
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "billing":{
        "paymentTiming": "Prepaid",
        "reservation": {
            "reservationLength": 1
        }
    },
    "engineVersion": "3.4",
    "storageEngine": "WiredTiger",
    "dbInstanceType": "sharding",
    "mongosCount": 2,
    "mongosCpuCount": 1,
    "mongosMemoryCapacity": 2,
    "shardCount": 2,
    "shardCpuCount": 1,
    "shardMemoryCapacity": 2,
    "shardStorage": 5,
    "shardStorageType": "LOCAL_DISK",
    "dbInstanceName": "myInstance",
    "accountPassword": "0f5c9202840d80d71d65d4100a48b67f",
    "vpcId": "vpc-jdni4sh8",
    "subnets":[
        {
            "zoneName": "cn-bj-a",
            "subnetId": "sbn-ien9ahe"
        }
    ],
    "restoreTime": "2017-11-20T20:00:00Z",
    ”tags":[
        {
            "tagKey": "tagKey-test",
            "tagValue": "tagvalue-test"
        }
    ]
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
    "dbInstanceSimpleModels" : ［
	    {
	        "dbInstanceId": "m-gGWeCM",
	        "connectionString: "mongodb://root:****@gGWeCMs7y.mongodb.bd.baidubce.com:27017,gGWeCMApo.mongodb.bd.baidubce.com:27017/admin",
	        "port": 27017
	    }
    ］
}

创建副本集实例

新增分片集实例组件

云数据库 DocDB for MongoDB

创建分片集实例