Domain name for API request: cls.tencentcloudapi.com.
This API is used to get the list of Kafka data subscription tasks.
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: DescribeKafkaRecharges. |
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. |
TopicId | Yes | String | Log topic ID |
Id | No | String | Import configuration ID |
Status | No | Integer | Status. Valid values: 1 (running) and 2 (suspended). |
Parameter Name | Type | Description |
---|---|---|
Infos | Array of KafkaRechargeInfo | KafkaRechargeInfo list |
TotalCount | Integer | Total Kafka data records imported |
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 get Kafka data import configuration.
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKafkaRecharges
<Common request parameters>
{
"TopicId": "abc",
"Status": 1
}
{
"Response": {
"Infos": [
{
"Id": "abc",
"TopicId": "abc",
"Name": "abc",
"ServerAddr": "test.cls.tencentyun.com:9095",
"UserKafkaTopics": "topic1,topic2",
"ConsumerGroupName": "",
"Status": 1,
"CreateTime": "abc",
"UpdateTime": "abc",
"LogRechargeRule": {
"RechargeType": "json_log",
"TimeKey": "abc",
"TimeFormat": "abc",
"LogRegex": "abc",
"UnMatchLogSwitch": true,
"UnMatchLogKey": "abc",
"EncodingFormat": 0,
"DefaultTimeSwitch": true
}
}
],
"TotalCount": 1,
"RequestId": "abc"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameter.TopicConflict | There is already a log topic with the same name in the specified logset. |
LimitExceeded | The quota limit has been reached. |
OperationDenied | Operation denied. |
OperationDenied.ACLFailed | ACL verification failed. |
OperationDenied.AccountDestroy | The account has been terminated. |
OperationDenied.AccountIsolate | The account has overdue payments. |
OperationDenied.AccountNotExists | The account does not exist. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.TopicNotExist | The log topic does not exist. |
Was this page helpful?