全部文档
当前文档
最近更新时间：2024-05-06 15:32:35
根据需求创建一个分片集实例，此接口只支持创建分片集实例。
POST
关于所有操作需要的通用参数，请参照通用请求-公共参数
英文名称 | 中文名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|---|
Action | 调用接口名称 | String | 是 | 取固定值：CreateMongoDBShardInstance |
Version | API版本号 | String | 是 | 取固定值：2017-01-01 |
Name | 实例名称 | String | 是 | 支持6-64个中文或者英文字符，包括汉字，大小写字母，数字，下划线和中划线 |
NetworkType | 网络类型 | String | 否 | 固定值2， 目前只支持创建VPC实例。 |
VpcId | 虚拟专用网络 | String | 是 | VPC网络ID，可在网络控制台获取。 |
VnetId | 终端子网id | String | 是 | 终端子网ID，可在网络控制台获取（注意类型必须为终端子网）。 |
InstanceAccount | 实例管理员账号 | String | 否 | 实例管理员账号 ： 默认账户名root |
InstancePassword | 实例管理员密码 | String | 是 | 实例管理员密码 |
PayType | 计费方式：默认为byMonth | String | 是 | 取值范围：byMonth（包年包月）,byDay（按日计费），hourlyInstantSettlement（按小时实时结算）。 |
Duration | 时长，默认值：1(单位:月) | Integer | 否 | 时长 默认值：1(单位:月) ；PayType=byMonth(包年包月)则必填，最大支持范围是(1 ~36月) |
IamProjectId | 项目ID | String | 否 | 默认为0：默认项目 |
ShardNum | shard数量 | Integer | 是 | 最小为2，取值范围[2-32] |
MongosNum | mongos数量 | Integer | 是 | 最小为2，范围[2~32] |
ShardClass | shard配置 | String | 是 | shard的CPU、内存配置，只能购买特定规格的套餐。详见实例规格 |
Storage | 磁盘大小 | Integer | 否 | shard的硬盘存储空间，根据实例配置选择。单位：GB。只能购买特定规格的套餐，详见实例规格 |
MongosClass | mongos配置 | String | 是 | mongos的CPU、内存配置，只能购买特定规格的套餐。详见实例规格 |
DbVersion | 数据库版本 | String | 否 | MongoDB引擎版本。可选值为：3.6，4.0等。 |
AvailabilityZone.N | 可用区 | String | 是 | 目前华北1（北京）、华东1（上海）支持跨可用区部署，其他机房暂不支持跨可用区部署。建议将实例创建在主机的可用内。详见查询可用机房及可用区 |
关于所有操作返回的错误信息，请参照通用请求－通用错误信息
请求样例
http://mongodb.api.ksyun.com/
api?Action=CreateMongoDBShardInstance
&Version=2017-01-01
&Name=SomebodyCallMe芒果
&InstancePassword=IamAdmin&NodeNum=3返回样例
{
"RequestId": "T0E1S2T3S-AFQWOFJQOJF-WFWFWF-FDGD",
"MongoDBInstanceResult": {
"UserId": "73403574",
"Region": "cn-shanghai-3",
"InstanceId": "e6933d66-7bae-4f43-af82-b74846d6076d",
"Name": "XB-Test-Create-MongoDB-001"
}
}纯净模式