InquireCkafkaPrice

Last updated: 2025-11-21 20:32:40

InquireCkafkaPrice

Last updated: 2025-11-21 20:32:40

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to purchase a CKafka instance or query the instance renewal price.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: InquireCkafkaPrice.
Version	Yes	String	Common Params. The value used for this API: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceType	Yes	String	Chinese site standard version fill in standards2 international site standard version fill in standard pro edition fill in profession advanced edition fill in premium.
InstanceChargeParam	No	InstanceChargeParam	Billing mode for instance purchase/renewal. If this parameter is left empty when you purchase an instance, the fees for one month under the monthly subscription mode will be displayed by default.
InstanceNum	No	Integer	The number of instances to be purchased or renewed. If this parameter is left empty, the default value is `1`.
Bandwidth	No	Integer	Specifies the internal network bandwidth size of the instance, in MB/s (required when purchased; bandwidth information is required for pro edition/advanced edition inquiries).
InquiryDiskParam	No	InquiryDiskParam	Specifies the purchase type and size of the hard disk of the instance. required when purchased. disk information is required for pro edition or advanced edition inquiries.
MessageRetention	No	Integer	Message retention period in hours, which is required when you purchase an instance.
Topic	No	Integer	The number of instance topics to be purchased, which is required when you purchase an instance.
Partition	No	Integer	Number of partitions for instance purchase, unit: unit (required when purchased; bandwidth information required for pro edition/advanced edition inquiry). Partition upper limit. maximum value of 40000. step length of 100. Specifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.comom/document/product/597/122563.?from_cn_redirect=1
ZoneIds.N	No	Array of Integer	The region for instance purchase, which can be obtained via the `DescribeCkafkaZone` API.
CategoryAction	No	String	Operation type flag. `purchase`: Making new purchases; `renew`: Renewing an instance. The default value is `purchase` if this parameter is left empty.
BillType	No	String	This field is not required.
PublicNetworkParam	No	InquiryPublicNetworkParam	Public network bandwidth billing mode. currently only the pro edition supports public network bandwidth. required when purchasing public network bandwidth. value must be a multiple of 3.
InstanceId	No	String	ID of the instance to be renewed, which is required when you renew an instance.

3. Output Parameters

Parameter Name	Type	Description
Result	InquireCkafkaPriceResp	Returned result.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Ckafka Pricing

Input Example

POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquireCkafkaPrice
<Common request parameters>

{
    "Partition": 800,
    "InstanceNum": 1,
    "InquiryDiskParam": {
        "DiskSize": 500,
        "DiskType": "SSD"
    },
    "ZoneIds": [
        100001
    ],
    "Topic": 30,
    "Bandwidth": 40,
    "MessageRetention": 4,
    "PublicNetworkParam": {
        "PublicNetworkChargeType": "BANDWIDTH_PREPAID",
        "PublicNetworkMonthly": 6
    },
    "InstanceChargeParam": {
        "InstanceChargePeriod": 1,
        "InstanceChargeType": "PREPAID"
    },
    "InstanceType": "profession",
    "CategoryAction": "purchase"
}

Output Example

{
    "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": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
AuthFailure	CAM signature/authentication error.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud