创建MongoDB实例

最近更新时间:2019-12-20 13:00:42

查看PDF

创建mongo副本集实例 CreateMongoDBInstance

根据需求创建一个副本集实例,此接口只支持创建副本集实例。

请求方式

POST

请求参数


关于所有操作需要的通用参数,请参照通用请求-[公共参数](https://docs.ksyun.com/documents/5921)
英文名称 中文名称 类型 是否必须 备注
Action 调用接口名称 String 取固定值:CreateMongoDBInstance
Version API版本号 String 取固定值:2017-01-01
Name mongo服务实例名称 String 支持6-64个中文或者英文字符,包括汉字,大小写字母,数字,下划线和中划线
DbVersion MongoDB引擎版本 String 目前仅支持WiredTiger,默认值为3.2,取值范围3.2、3.6
InstanceClass 实例规格 String 实例配置,客户只能购买特定规格的套餐。详见实例规格
Storage 磁盘大小 Integer 硬盘区间值, 单位是GB
NetworkType 网络类型 String 固定值VPC, 目前只支持创建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:默认项目
NodeNum 节点数 Integer 默认为3,取值范文3、5、7。为实例所有节点数,每个实例包含一个primary一个hidden节点,其余为secondary节点。
AvailabilityZone.N 可用区 String 目前暂不支持跨可用区,建议将实例创建在云主机的可用区内已减少网络延时.可查询可用机房及可用区

返回结果

英文名称 中文名称 类型 是否必须 备注
RequestId 请求ID String
Data 返回数据信息 Object 返回列表的数据信息,具体可以查看参数列表中的返回例子
Error 错误 String Code:错误状态码 Message:文字描述

错误信息

关于所有操作返回的错误信息,请参照通用请求-通用错误信息

样例

  • 请求样例
http://mongodb.${region}.api.ksyun.com/ 
api?Action=CreateMongoDBInstance
&Version=2017-01-01
&Name=SomebodyCallMe芒果
&InstancePassword=IamAdmin
  • 返回样例

{
  "RequestId": "T0E1S2T3S-AFQWOFJQOJF-WFWFWF-FDGD",
  "MongoDBInstanceResult": {
    "UserId": "73403574",
    "Region": "cn-shanghai-3",
    "InstanceId": "e6933d66-7bae-4f43-af82-b74846d6076d",
    "Name": "XB-Test-Create-MongoDB-001"
  }
}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈