1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
Ckafka实例购买/续费询价
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：InquireCkafkaPrice。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceType | 是 | String | 国内站标准版填写standards2, 国际站标准版填写standard,专业版填写profession,高级版填写premium 示例值：profession |
| InstanceChargeParam | 否 | InstanceChargeParam | 购买/续费付费类型(购买时不填的话, 默认获取购买包年包月一个月的费用) 示例值：{"InstanceChargeType":"PREPAID", "InstanceChargePeriod": 1} |
| InstanceNum | 否 | Integer | 购买/续费时购买的实例数量(不填时, 默认为1个) 示例值：1 |
| Bandwidth | 否 | Integer | 实例内网带宽大小, 单位MB/s (购买时必填，专业版/高级版询价时带宽信息必填) 示例值：40 |
| InquiryDiskParam | 否 | InquiryDiskParam | 实例的硬盘购买类型以及大小 (购买时必填，专业版/高级版询价时磁盘信息必填) 示例值：{"DiskType":"SSD", "DiskSize": 500} |
| MessageRetention | 否 | Integer | 实例消息保留时间大小, 单位小时 (购买时必填) 示例值：1 |
| Topic | 否 | Integer | 购买实例topic数, 单位个 (购买时必填) 示例值：40 |
| Partition | 否 | Integer | 购买实例分区数, 单位个 (购买时必填，专业版/高级版询价时带宽信息必填) 示例值：40 |
| ZoneIds.N | 否 | Array of Integer | 购买地域, 可通过查看DescribeCkafkaZone这个接口获取ZoneId 示例值：[100001] |
| CategoryAction | 否 | String | 标记操作, 新购填写purchase, 续费填写renew, (不填时, 默认为purchase) 示例值：purchase |
| BillType | 否 | String | 国内站购买的版本, sv_ckafka_instance_s2_1(入门型), sv_ckafka_instance_s2_2(标准版), sv_ckafka_instance_s2_3(进阶型), 如果instanceType为standards2, 但该参数为空, 则默认值为sv_ckafka_instance_s2_1 示例值：sv_ckafka_instance_s2_1 |
| PublicNetworkParam | 否 | InquiryPublicNetworkParam | 公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填) 示例值："" |
| InstanceId | 否 | String | 续费时的实例id, 续费时填写 示例值：ckafka-xxxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | InquireCkafkaPriceResp | 出参 示例值：xxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Ckafka询价
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquireCkafkaPrice
<公共请求参数>
{
"Partition": 40,
"InstanceNum": 1,
"InquiryDiskParam": {
"DiskSize": 500,
"DiskType": "SSD"
},
"ZoneIds": [
100001
],
"Topic": 30,
"Bandwidth": 40,
"MessageRetention": 4,
"PublicNetworkParam": {
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"PublicNetworkMonthly": 10
},
"InstanceChargeParam": {
"InstanceChargePeriod": 1,
"InstanceChargeType": "PREPAID"
},
"InstanceType": "profession",
"CategoryAction": "purchase"
}输出示例
{
"Response": {
"Result": {
"InstancePrice": {
"DetailPrices": {
"BandwidthPrice": {
"UnitPrice": 0,
"UnitPriceDiscount": 0,
"OriginalPrice": 0,
"DiscountPrice": 0,
"Discount": 100,
"GoodsNum": null,
"Currency": null,
"DiskType": null,
"TimeSpan": null,
"TimeUnit": null,
"Value": 0
},
"DiskPrice": {
"UnitPrice": 175,
"UnitPriceDiscount": 50.1,
"OriginalPrice": 175,
"DiscountPrice": 50.1,
"Discount": 28.3,
"GoodsNum": null,
"Currency": null,
"DiskType": "CLOUD_BASIC",
"TimeSpan": null,
"TimeUnit": null,
"Value": 500
},
"PartitionPrice": {
"UnitPrice": 0,
"UnitPriceDiscount": 0,
"OriginalPrice": 0,
"DiscountPrice": 0,
"Discount": 100,
"GoodsNum": null,
"Currency": null,
"DiskType": null,
"TimeSpan": null,
"TimeUnit": null,
"Value": 0
},
"TopicPrice": {
"UnitPrice": 0,
"UnitPriceDiscount": 0,
"OriginalPrice": 0,
"DiscountPrice": 0,
"Discount": 100,
"GoodsNum": null,
"Currency": null,
"DiskType": null,
"TimeSpan": null,
"TimeUnit": null,
"Value": 0
},
"InstanceTypePrice": {
"UnitPrice": 190,
"UnitPriceDiscount": 57.56,
"OriginalPrice": 190,
"DiscountPrice": 7.56,
"Discount": 30.3,
"GoodsNum": null,
"Currency": null,
"DiskType": null,
"TimeSpan": null,
"TimeUnit": null,
"Value": 1
}
},
"UnitPrice": 265,
"UnitPriceDiscount": 647.7,
"OriginalPrice": 265,
"DiscountPrice": 67.67,
"Discount": 29.92,
"GoodsNum": 1,
"Currency": "CNY",
"DiskType": null,
"TimeSpan": 1,
"TimeUnit": "m",
"Value": null
},
"PublicNetworkBandwidthPrice": null
},
"RequestId": "xxxx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |