API 文档

创建实例询价

最近更新时间:2021-02-04 08:25:57

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口用于创建数据库实例询价。本接口参数中必须传入region参数,否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InquirePriceCreateDBInstances。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
Zone String 实例所属区域名称,格式如:ap-guangzhou-2
NodeNum Integer 每个副本集内节点个数,当前副本集节点数固定为3,分片从节点数可选,具体参照查询云数据库的售卖规格返回参数
Memory Integer 实例内存大小,单位:GB
Volume Integer 实例硬盘大小,单位:GB
MongoVersion String 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本,MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本,MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本
MachineCode String 机器类型,HIO:高IO型;HIO10G:高IO万兆型;STDS5:标准型
GoodsNum Integer 实例数量, 最小值1,最大值为10
Period Integer 实例时长,单位:月,可选值包括[1,2,3,4,5,6,7,8,9,10,11,12,24,36]
ClusterType String 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
ReplicateSetNum Integer 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0

3. 输出参数

参数名称 类型 描述
Price DBInstancePrice 价格
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询新购数据库实例价格

输入示例

https://mongodb.tencentcloudapi.com/?Action=InquirePriceCreateDBInstances
&Zone=ap-guangzhou-4
&NodeNum=3
&Memory=4
&Volume=100
&MongoVersion=MONGO_36_WT
&MachineCode=HIO10G
&GoodsNum=2
&Period=1
&ClusterType=REPLSET
&ReplicateSetNum=1
&<公共请求参数>

输出示例

{
  "Response": {
    "Price": {
      "DiscountPrice": 1340,
      "OriginalPrice": 1340,
      "UnitPrice": 670
    },
    "RequestId": "fb8b4646-389d-44cc-ab8c-98c081cbdad3"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.PermissionDenied 当前子帐号无权执行该操作。
InvalidParameterValue.ReplicaSetNumError 副本集(分片)数量错误。
InvalidParameterValue.ZoneError 无效的可用区。
目录