创建分片集实例
更新时间：2025-08-21
前提条件
创建实例需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。
说明
- 本接口用于创建相同配置的云数据库 DocDB for MongoDB 实例，目前仅支持一次创建一个。
- 创建预付费方式的实例则需要账户现金余额大于等于实例费用。
- 创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。
请求结构
Plain Text
1POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4{
5 "billing":{
6 "paymentTiming": paymentTiming,
7 "reservation": {
8 "reservationLength": reservationLength
9 }
10 },
11 "engineVersion": dbVersion,
12 "storageEngine": dbEngine,
13 "dbInstanceType": dbInstanceType,
14 "mongosCount": mognosCount,
15 "mongosCpuCount": mongosCpuCount,
16 "mongosMemoryCapacity": mongosMemoryCapacity,
17 "shardCount": shardCount,
18 "shardCpuCount": shardCount,
19 "shardMemoryCapacity": shardMemoryCapacity,
20 "shardStorage": shardStorage,
21 "shardStorageType": shardStorageType,
22 "dbInstanceName": dbName,
23 "accountPassword": password,
24 "srcDbInstanceId": srcDbInstanceId,
25 "backupId": backupId,
26 "vpcId": vpcId,
27 "subnets":[
28 {
29 "zoneName": zoneName,
30 "subnetId": subnetId
31 }
32 ],
33 "restoreTime": restoreTime,
34 "tags":[
35 {
36 "tagKey": tagKey,
37 "tagValue": tagValue
38 }
39 ]
40}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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 | 创建的实例信息 |
请求示例
Plain Text
1POST /v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "billing":{
8 "paymentTiming": "Prepaid",
9 "reservation": {
10 "reservationLength": 1
11 }
12 },
13 "engineVersion": "3.4",
14 "storageEngine": "WiredTiger",
15 "dbInstanceType": "sharding",
16 "mongosCount": 2,
17 "mongosCpuCount": 1,
18 "mongosMemoryCapacity": 2,
19 "shardCount": 2,
20 "shardCpuCount": 1,
21 "shardMemoryCapacity": 2,
22 "shardStorage": 5,
23 "shardStorageType": "LOCAL_DISK",
24 "dbInstanceName": "myInstance",
25 "accountPassword": "0f5c9202840d80d71d65d4100a48b67f",
26 "vpcId": "vpc-jdni4sh8",
27 "subnets":[
28 {
29 "zoneName": "cn-bj-a",
30 "subnetId": "sbn-ien9ahe"
31 }
32 ],
33 "restoreTime": "2017-11-20T20:00:00Z",
34 ”tags":[
35 {
36 "tagKey": "tagKey-test",
37 "tagValue": "tagvalue-test"
38 }
39 ]
40}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5 "dbInstanceSimpleModels" : ［
6 {
7 "dbInstanceId": "m-gGWeCM",
8 "connectionString: "mongodb://root:****@gGWeCMs7y.mongodb.bd.baidubce.com:27017,gGWeCMApo.mongodb.bd.baidubce.com:27017/admin",
9 "port": 27017
10 }
11 ］
12}