有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InquirePriceCreateDBInstances。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
Zone String 实例所属区域及可用区信息。格式:ap-guangzhou-2。
示例值:ap-guangzhou-4
NodeNum Integer 每个分片的主从节点数量。
取值范围:请通过接口DescribeSpecInfo查询,其返回的数据结构SpecItems中的参数MinNodeNum与MaxNodeNum分别对应其最小值与最大值。
示例值:3
Memory Integer 实例内存大小。
- 单位:GB。
- 取值范围:请通过接口DescribeSpecInfo查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。
示例值:4
Volume Integer 实例硬盘大小。
- 单位:GB。
- 取值范围:请通过接口DescribeSpecInfo查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。
示例值:100
MongoVersion String 实例版本信息。具体支持的版本,请通过接口DescribeSpecInfo查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:
- 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存储引擎版本。
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
示例值:MONGO_36_WT
MachineCode String 机器类型。
- HIO:高IO型。
- HIO10G:高IO万兆型。
示例值:HIO10G
GoodsNum Integer 实例数量,取值范围为[1,10]。
示例值:2
ClusterType String 实例类型。
- REPLSET:副本集。
- SHARD:分片集群。
- STANDALONE:单节点。
示例值:REPLSET
ReplicateSetNum Integer 副本集个数。
- 创建副本集实例时,该参数固定设置为1。
- 创建分片集群时,指分片数量,请通过接口DescribeSpecInfo查询,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
- 若为单节点实例,该参数固定设置为0。
示例值:1
Period Integer - 选择包年包月计费模式,即 InstanceChargeType 设定为PREPAID时,需设定购买实例的时长。该参数取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
-选择按量计费,即 InstanceChargeType 设定为 POSTPAID_BY_HOUR 时,该参数仅可配置为 1。
示例值:1
InstanceChargeType String 实例付费方式。
- PREPAID:包年包月计费。
- POSTPAID_BY_HOUR:按量计费。
示例值:PREPAID
MongosCpu Integer 分片实例询价必填参数,指 Mongos CPU核数,取值范围为[1,16]。
示例值:2
MongosMemory Integer 分片实例询价必填参数,指 Mongos 内存,取值范围为[2,32],单位:GB。
示例值:4
MongosNum Integer 分片实例询价必填参数,指 Mongos 个数,取值范围为[3,32]。
示例值:3
ConfigServerCpu Integer 分片实例询价必填参数,指 ConfigServer CPU核数,取值为1,单位:GB。
示例值:1
ConfigServerMemory Integer 分片实例询价必填参数,指 ConfigServer 内存大小,取值为2,单位:GB。
示例值:2
ConfigServerVolume Integer 分片实例询价必填参数,指 ConfigServer 磁盘大小,取值为 20,单位:GB。
示例值:50

3. 输出参数

参数名称 类型 描述
Price DBInstancePrice 价格
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquirePriceCreateDBInstances
<公共请求参数>

{
    "GoodsNum": "2",
    "Zone": "ap-guangzhou-4",
    "Memory": "4",
    "Period": "1",
    "ClusterType": "REPLSET",
    "Volume": "100",
    "NodeNum": "3",
    "ReplicateSetNum": "1",
    "MachineCode": "HIO10G",
    "MongoVersion": "MONGO_36_WT"
}

输出示例

{
    "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.MachineTypeError 错误的机型。
InvalidParameterValue.MongoVersionError 实例版本错误。
InvalidParameterValue.ReplicaSetNumError 副本集(分片)数量错误。
InvalidParameterValue.SpecNotOnSale 购买规格错误。
InvalidParameterValue.ZoneClosed 可用区已关闭售卖。
InvalidParameterValue.ZoneError 无效的可用区。