全部文档
当前文档
最近更新时间：2024-09-05 10:21:59
根据需求创建一个实例。
POST
关于所有操作需要的通用参数，请参照通用请求-公共参数
英文名称 | 中文名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|---|
Action | 调用接口名称 | String | 是 | 取固定值：CreateMongoDBInstance |
Version | API版本号 | String | 是 | 取固定值：2017-01-01 |
Name | Mongo服务实例名称 | String | 是 | 支持6-64个中文或者英文字符，包括汉字，大小写字母，数字，下划线和中划线 |
DbVersion | MongoDB引擎版本 | String | 是 | 若mode参数选择Cluster取值范围:3.2 3.6 4.0 ；若选择HighIO,则只支持3.6 |
InstanceClass | 实例规格 | String | 是 | 创建副本集实例时可选，默认1C2G，客户只能购买特定规格的套餐。详见实例规格 |
Storage | 磁盘大小 | Integer | 是 | 硬盘区间值, 单位是GB |
VpcId | 虚拟专用网络 | String | 是 | VPC网络ID，可在网络控制台获取。 |
VnetId | 终端子网id | String | 否 | 终端子网ID，可在网络控制台获取（注意类型必须为终端子网）。 |
InstancePassword | 实例管理员密码 | String | 是 | 实例管理员密码 |
PayType | 计费方式 | String | 否 | 默认为byMonth，取值范围：byMonth（包年包月）,byDay（按日计费），hourlyInstantSettlement（按量计费）。 |
Duration | 时长，默认值：1(单位:月) | Integer | 否 | 时长 默认值：1(单位:月) ；PayType=byMonth(包年包月)则必填，最大支持范围是(1 ~36月) |
IamProjectId | 项目ID | String | 否 | 默认为0：默认项目 |
iamProjectName | 所属项目名称 | String | 否 | 所属项目名称 |
NodeNum | 节点数 | Integer | 否 | 默认为3，取值范围3、5、7。为实例所有节点数，每个实例包含一个primary一个hidden节点，其余为secondary节点。若mode参数选择HighIO,则取值范围为3 |
AvailabilityZone.N | 可用区 | String | 是 | 目前华北1（北京）支持跨可用区部署，其他机房暂不支持跨可用区部署。建议将实例创建在云主机的可用区内以减少网络延时。详见查询可用机房及可用区 |
shardClass | shard节点配置(分片集群) | String | 否 | 创建分片集群实例时可选shard节点配置，取值范围为1C2G，2C4G，4C8G，8C16G，8C32G，16C64G，默认1C2G |
shardNum | shard数量(分片集群) | Integer | 否 | shard数量，创建分片集群实例时必传，取值范围为2~32 |
mongosClass | mongos节点配置(分片集群) | String | 否 | 创建分片集群实例时可选mongos节点配置，取值范围为1C2G，2C4G，4C8G，8C16G，8C32G，16C64G，默认1C2G |
MongosNum | mongos数量(分片集群) | Integer | 否 | 创建分片集群实例时必传，取值范围为2~32 |
英文名称 | 中文名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|---|
RequestId | 请求ID | String | 是 | -- |
Data | 返回数据信息 | Object | 否 | 返回列表的数据信息，具体可以查看参数列表中的返回例子 |
Error | 错误 | String | 否 | Code：错误状态码 Message：文字描述 |
关于所有操作返回的错误信息，请参照通用请求－通用错误信息
http://mongodb.{{region}}.api.ksyun.com/api?Version=2017-01-01&Action=CreateMongoDBInstance&PayType=byDay&availabilityZone=******&mode=Cluster&Name=lb_testMONGODB_SHARD&dbVersion=3.6&storage=10&iamProjectName=默认项目&iamProjectId=0&vpcId=30048550-1af2-4d5a-ad59-ef3363b3ca09&InstancePassword=Libai_test01&VnetId=52fac9f0-16e2-4ae0-8fef-bfd8ed67b339&mongosNum=2&shardNum=2{
"RequestId": "b11e65e1-7b0b-4210-9f39-7014590e60ac",
"MongoDBInstanceResult": {
"UserId": "2000102274",
"Region": "******",
"InstanceId": "b3eacca0-ff75-4121-a472-49456835b116",
"Name": "lb_testMONGODB_SHARD"
}
}纯净模式