Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to preview the logs 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: PreviewKafkaRecharge. |
| 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. |
| PreviewType | Yes | Integer | Preview type. 1: preview of source data; 2: preview of exported results. |
| KafkaType | Yes | Integer | Import Kafka type. 0: Tencent Cloud CKafka; 1: user-built kafka. |
| UserKafkaTopics | Yes | String | List of Kafka-related topics to be imported by the user, topics separated by commas. Supports up to 100. |
| Offset | Yes | Integer | Import data location. -2: earliest; -1: latest. |
| KafkaInstance | No | String | Tencent Cloud CKafka instance ID. The parameter KafkaInstance is valid and required when KafkaType is 0. -Get the instance id through Get Instance List. |
| ServerAddr | No | String | Service address. When KafkaType is 1, ServerAddr is required. |
| IsEncryptionAddr | No | Boolean | Whether ServerAddr is a secure connection. Valid when KafkaType is 1. |
| Protocol | No | KafkaProtocolInfo | Encrypted Access Protocol. When KafkaType is 1 and IsEncryptionAddr is true, Protocol is required. |
| ConsumerGroupName | No | String | User Kafka consumer group. -A consumption group is a scalable and fault-tolerant consumer mechanism provided by Kafka. Multiple consumers exist in a consumption group, and all consumers in the group consume subscribed data of messages in the Topic. A consumer can consume multiple partitions simultaneously, but one Partition can only be consumed by a single consumer in the group. |
| LogRechargeRule | No | LogRechargeRuleInfo | Log import rule |
| UserKafkaMeta | No | UserKafkaMeta | User kafka extended information |
| Parameter Name | Type | Description |
|---|---|---|
| LogSample | String | Log sample, which is returned when PreviewType is set to 2 |
| LogData | String | Log preview results |
| 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 preview the source data.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PreviewKafkaRecharge
<Common request parameters>
{
"PreviewType": 1,
"KafkaType": 0,
"KafkaInstance": "ckafka-k9m5vj75",
"UserKafkaTopics": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
"ConsumerGroupName": "",
"Offset": -1
}
{
"Response": {
"RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx",
"LogData": "rmap[AvailIndexTraffic:0 AvailStore:0 ClusterAvailableTrafficCapacity:0...",
"LogSample": ""
}
}
export result preview
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PreviewKafkaRecharge
<Common request parameters>
{
"PreviewType": 2,
"KafkaType": 0,
"KafkaInstance": "ckafka-l4rped7z",
"UserKafkaTopics": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
"ConsumerGroupName": "",
"Offset": -2,
"LogRechargeRule": {
"RechargeType": "minimalist_log",
"LogRegex": "",
"UnMatchLogSwitch": true,
"UnMatchLogKey": "LogParseFailure",
"UnMatchLogTimeSrc": 0,
"EncodingFormat": 0,
"DefaultTimeSwitch": true,
"DefaultTimeSrc": 0,
"TimeKey": "",
"TimeRegex": "",
"TimeFormat": "",
"TimeZone": "UTC+08:00",
"Metadata": [
"kafka_topic",
"kafka_partition",
"kafka_offset",
"kafka_timestamp"
],
"Keys": []
}
}
{
"Response": {
"LogSample": "{\"x-intranet-proxy-region\":\"sh\",\"x-intranet-proxy-socket-local-address\":\"::ffff:11.179.111.111\",\"x-intranet-proxy-socket-local-port\":\"8443\"",
"LogData": "{\"__CONTENT__\":\"{\\\"x-intranet-proxy-region\\\":\\\"sh\\\",\\\"x-intranet-proxy-socket-local-address\\\":\\\"::ffff:11.179.111.111\\\",\\\"x-intranet-proxy-socket-local-port\\\":\\\"8443\\\"",
"RequestId": "d3218ba6-4d98-480a-a97b-8db0ae87ef31"
}
}
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. |
| FailedOperation.Timeout | Operation timed out |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
文档反馈