1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
本接口(DescribeDBPrice)用于查询购买或续费云数据库实例的价格，支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。可传入实例名称来查询实例续费价格。
注意：对某个地域进行询价，请使用对应地域的接入点，接入点信息请参照 服务地址 文档。例如：对广州地域进行询价，请把请求发到：cdb.ap-guangzhou.tencentcloudapi.com。同理对上海地域询价，把请求发到：cdb.ap-shanghai.tencentcloudapi.com。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDBPrice。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Period | 是 | Integer | 实例时长，单位：月，最小值 1，最大值为 36；查询按量计费价格时，该字段无效。 示例值：1 |
| Zone | 否 | String | 可用区信息，格式如 "ap-guangzhou-2"。具体能设置的值请通过 DescribeDBZoneConfig 接口查询。InstanceId为空时该参数为必填项。 示例值：ap-guangzhou-2 |
| GoodsNum | 否 | Integer | 实例数量，默认值为 1，最小值 1，最大值为 100。InstanceId为空时该参数为必填项。 示例值：1 |
| Memory | 否 | Integer | 实例内存大小，单位：MB。InstanceId为空时该参数为必填项。 示例值：1000 |
| Volume | 否 | Integer | 实例硬盘大小，单位：GB。InstanceId为空时该参数为必填项。 示例值：50 |
| InstanceRole | 否 | String | 实例类型，默认为 master，支持值包括：master - 表示主实例，ro - 表示只读实例，dr - 表示灾备实例。InstanceId为空时该参数为必填项。 示例值：master |
| PayType | 否 | String | 付费类型，支持值包括：PRE_PAID - 包年包月，HOUR_PAID - 按量计费。InstanceId为空时该参数为必填项。 示例值：PRE_PAID |
| ProtectMode | 否 | Integer | 数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。 示例值：0 |
| DeviceType | 否 | String | 实例隔离类型。支持值包括： "UNIVERSAL" - 通用型实例， "EXCLUSIVE" - 独享型实例， "BASIC_V2" - 单节点云盘版实例。 不指定则默认为通用型实例。 示例值：UNIVERSAL |
| InstanceNodes | 否 | Integer | 实例节点数。对于 RO 和 基础版实例， 该值默认为1。 如果需要询价三节点实例， 请将该值设置为3。其余主实例该值默认为2。 示例值：2 |
| Cpu | 否 | Integer | 询价实例的CPU核心数目，单位：核，为保证传入 CPU 值有效，请使用 获取云数据库可售卖规格 接口获取可售卖的核心数目，当未指定该值时，将按照 Memory 大小补全一个默认值。 示例值：4 |
| InstanceId | 否 | String | 询价续费实例ID。如需查询实例续费价格，填写InstanceId和Period即可。 示例值："cdb-xxx" |
| Ladder | 否 | Integer | 按量计费阶梯。仅PayType=HOUR_PAID有效，支持值包括：1，2，3。阶梯时长见https://cloud.tencent.com/document/product/236/18335。 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Price | Integer | 实例价格，单位：分。 示例值：48000 |
| OriginalPrice | Integer | 实例原价，单位：分。 示例值：460800 |
| Currency | String | 货币单位。CNY-人民币，USD-美元。 示例值：CNY |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询数据库实例新购价格
查询数据库实例新购价格
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBPrice
<公共请求参数>
{
"Zone": "ap-guangzhou-1",
"GoodsNum": "1",
"PayType": "PRE_PAID",
"Period": "24",
"Volume": "25",
"Memory": "1000"
}输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"Currency": "CNY",
"Price": 48000,
"OriginalPrice": 460800
}
}示例2 查询数据库实例续费价格
查询数据库实例续费价格
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBPrice
<公共请求参数>
{
"InstanceId": "cdb-6no119yd",
"Period": "24"
}输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"Currency": "CNY",
"Price": 48000,
"OriginalPrice": 460800
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CauthError | 鉴权失败。 |
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.TradeError | 交易系统错误。 |
| InternalError.UndefinedError | 未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 实例不存在。 |
