全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

创建MongoDB实例

最近更新时间:2024-04-19 15:10:17

CreateMongoDBInstance

根据需求创建一个实例。

请求方式

POST

请求参数

关于所有操作需要的通用参数,请参照通用请求-公共参数

英文名称

中文名称

类型

是否必须

备注

Action

调用接口名称

String

取固定值:CreateMongoDBInstance

Version

API版本号

String

取固定值:2017-01-01

mode

实例类型

String

实例类型

分片集群Cluster,副本集HighIO,默认HighIO

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(按日计费),byHour(按小时结算)。

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

目前暂不支持跨可用区,建议将实例创建在云主机的可用区内已减少网络延时.可查询可用机房及可用区

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"
    }
}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈