Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to check whether the Kafka service cluster is accessible.
A maximum of 20 requests can be initiated per second for this API.
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: CheckRechargeKafkaServer. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KafkaType | Yes | Integer | Import Kafka type. 0: Tencent Cloud CKafka; 1: user-built kafka. |
| KafkaInstance | No | String | Tencent Cloud CKafka instance ID. When KafkaType is 0, KafkaInstance is required - Obtain the instance id by searching the instance list information (https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1). |
| ServerAddr | No | String | Service AddressWhen KafkaType is 1, ServerAddr is required |
| IsEncryptionAddr | No | Boolean | Whether ServerAddr is an encrypted connection. The default value is false. It is valid when KafkaType is 1, indicating a user self-built Kafka. |
| Protocol | No | KafkaProtocolInfo | Encrypted access protocol. It is required when the parameter KafkaType is 1 and the parameter IsEncryptionAddr is true. |
| UserKafkaMeta | No | UserKafkaMeta | User kafka extended information |
| Parameter Name | Type | Description |
|---|---|---|
| Status | Integer | Accessibility status of the Kafka cluster. -0: Normal access. -1: broker connection failure -2: sasl authentication failure -3: ckafka role not authorized -4: topic list does not exist. -5: No data available in the topic. -6: User has no ckafka permission. -7: The consumption group already exists. -8: The kafka instance does not exist or is terminated. -9: Broker list is empty -10: Incorrect Broker address format. -11: Broker port is not an integer. |
| 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. |
Verifying Whether the Kafka Service Address Entered by the User Is Accessible
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckRechargeKafkaServer
<Common request parameters>
{
"KafkaType": 0,
"KafkaInstance": "ckafka-8j4ro59xx",
"UserKafkaMeta": {
"KafkaVersion": "2.0.0"
}
}
{
"Response": {
"Status": 0,
"RequestId": "add346ce-36c5-4961-917f-c020b5fc4bfd"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback