1. 接口描述
本接口 (DescribeMongoDBProduct) 用于查询可创建的实例规格，返回可创建实例的购买时长，以及按可用区分类返回可创建实例的机器类型、副本集节点数、内存大小、磁盘范围以及数据库版本号。
接口请求域名：mongodb.api.qcloud.com
2. 输入参数
参数名称 | 是否必选 | 类型 | 描述 |
zoneIds.n | 否 | String | 可用区 ID 组成的数组，数组下标从0开始, 若不传此参数将返回所有区域产品信息。 |
其中，可用区定义如下：
可用区 | zoneId |
广州一区 | 100001 |
广州二区 | 100002 |
广州三区 | 100003 |
上海一区 | 200001 |
香港一区 | 300001 |
北京一区 | 800001 |
3. 输出参数
参数名称 | 类型 | 描述 |
code | Int | |
message | String | 错误信息描述, 成功时，该值为空。 |
codeDesc | String | 业务侧错误码英文描述。成功时返回 Success，错误时返回具体业务错误原因。 |
data | Object | 可创建实例规格的配置信息。 |
其中，data 表示可创建实例规格的配置信息，其参数构成如下：
参数名称 | 类型 | 描述 |
timeSpan | Array | 用户可购买实例的时长 |
timeUnit | String | 用户可购买实例的时长单位，m:月，d：天 |
goodsDescription | Object | 可创建的实例规格信息 |
其中， goodsDescription 表示实例配置信息，其参数构成如下：
参数名称 | 类型 | 描述 |
100002/100003/... | Object | 可用区ID |
其中， 100002为可用区 ID， 其值表示该可用区下支持的实例规格信息，其参数构成如下：
参数名称 | 类型 | 描述 |
region | String | |
isSupportVpc | Bool | 是否支持私有网络，其值包括：true 和 false。 |
types | Object | 支持的实例规格内容。 |
其中，types 表示支持的实例规格内容，其参数构成如下：
参数名称 | 类型 | 描述 |
typeId | String | 实例类型英文名称。 GIO：高 IO 版；TGIO：高 IO 万兆 |
replicationNodeNum | Array | 副本集节点数，暂时只支持节点数为2、3 |
memory | Int | 实例内存大小，每一个内存值对应一个可选的磁盘大小范围，单位：MB |
volumeMax | Int | 选定内存后，实例硬盘大小可选的最大值，单位：GB |
volumeMin | Int | 选定内存后，实例硬盘大小可选的最小值，单位：GB |
volumeStep | Int | 选定内存后，实例硬盘大小的步长，单位：GB； 创建实例时，硬盘（volume）的取值是：volume= volumeMin + volumeStep * n; 同时 volumeMin <= volume <= volumeMax |
version | Array | 可支持的数据库版本号，例如 MONGO_3_MMAP、MONGO_3_WT |
4. 错误码
以下错误码表列出了该接口的业务逻辑错误码。
错误代码 | 英文提示 | 错误描述 |
11050 | InvalidParameter | 业务参数错误 |
11060 | ServiceUnavailable | 请求的区域暂时不提供服务 |
5. 示例
输入
https://mongodb.api.qcloud.com/v2/index.php?Action=DescribeMongoDBProduct&<公共请求参数>&zoneIds.0=100002&zoneIds.1=200001
输出
{"code": 0,"message": "","codeDesc": "Success","data": {"timeSpan": [1,2,3,4,5,6,7,8,9,10,11,12,24,36],"timeUnit": "m","goodsDescription": {"100002": {"region": "gz","isSupportVpc": true,"types": [{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 2048,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 4096,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 6144,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 8192,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 12288,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 16384,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 24576,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 32768,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 49152,"volumeMax": 750,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 61440,"volumeMax": 1000,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 65536,"volumeMax": 1000,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]}]},"200001": {"region": "sh","isSupportVpc": true,"types": [{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 2048,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 4096,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 6144,"volumeMax": 250,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 8192,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 12288,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 16384,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 24576,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 32768,"volumeMax": 500,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 49152,"volumeMax": 750,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 61440,"volumeMax": 1000,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]},{"typeId": "GIO","replicationNodeNum": [2,3],"memory": 65536,"volumeMax": 1000,"volumeMin": 25,"volumeStep": 5,"version": ["MONGO_3_MMAP","MONGO_3_WT"]}]}}}}
