Domain name for API request: cls.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 | No | String | Common Params. This parameter is not required for this API. |
KafkaType | Yes | Integer | Kafka type. Valid values: 0 (Tencent Cloud CKafka) and 1 (customer's Kafka). |
KafkaInstance | No | String | Tencent Cloud CKafka Instance IDWhen KafkaType is 0, KafkaInstance is required |
ServerAddr | No | String | Service AddressWhen KafkaType is 1, ServerAddr is required |
IsEncryptionAddr | No | Boolean | Whether the service address uses an encrypted connection |
Protocol | No | KafkaProtocolInfo | Encryption access protocol. Required when IsEncryptionAddr parameter is set to true |
Parameter Name | Type | Description |
---|---|---|
Status | Integer | Kafka cluster accessibility. 0: Accessible. Note: This field may return null, indicating that no valid values can be obtained. |
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. |
This example shows you how to check whether a Kafka service address is accessible.
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCosRecharge
<Common request parameters>
{
"KafkaType": 1,
"ServerAddr": "est.cls.tencentyun.com:9095",
"IsEncryptionAddr": false
}
{
"Response": {
"RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx",
"Status": 0
}
}
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?