tencent cloud

All product documents
APIs
DocumentationAPIsCloud Log ServiceKafka Data Subscription APIsPreviewKafkaRecharge
PreviewKafkaRecharge
Last updated: 2025-03-11 22:20:38
PreviewKafkaRecharge
Last updated: 2025-03-11 22:20:38

1. API Description

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.

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: PreviewKafkaRecharge.
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.
PreviewType Yes Integer Preview type. Valid values: 1 (source data preview) and 2 (result preview).
KafkaType Yes Integer Kafka type. Valid values: 0 (Tencent Cloud CKafka) and 1 (customer's Kafka)
UserKafkaTopics Yes String List of Kafka-related topics that the user needs to import, separated by commas. Supports up to 100 topics.
Offset Yes Integer Position for data import. Valid values: -2 (earliest, default) and -1 (latest).
KafkaInstance No String Tencent Cloud CKafka instance ID.
KafkaInstance is required when KafkaType is 0
ServerAddr No String Service AddressServerAddr is required when KafkaType is 1
IsEncryptionAddr No Boolean Whether ServerAddr is a secure connection.
Valid when KafkaType is 1.
Protocol No KafkaProtocolInfo Encrypted Access ProtocolWhen KafkaType is 1 and IsEncryptionAddr is true, Protocol is required
ConsumerGroupName No String Kafka consumer group name
LogRechargeRule No LogRechargeRuleInfo Log import rule

3. Output Parameters

Parameter Name Type Description
LogSample String Log sample, which is returned when PreviewType is set to 2
LogData String Log preview result
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.

4. Example

Example1 Previewing the Logs of Kafka Data Import Tasks

This example shows you how to preview the logs of Kafka data import tasks.

Input Example

POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCosRecharge
<Common request parameters>
{
    "PreviewType": 1,
    "KafkaType": 1,
    "ServerAddr": "test.cls.tencentyun.com:9095",
    "IsEncryptionAddr": false,
    "UserKafkaTopics": "topic1,topic2",
    "Offset": -1,
    "LogRechargeRule": {
        "RechargeType": "json_log",
        "TimeKey": "abc",
        "TimeFormat": "abc",
        "LogRegex": "abc",
        "UnMatchLogSwitch": true,
        "UnMatchLogKey": "abc",
        "EncodingFormat": 0,
        "DefaultTimeSwitch": true
    }
}

Output Example

{
    "Response": {
        "RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx",
        "LogData": "xxxxxxx",
        "LogSample": "abc"
    }
}

Example2 Preview of Data Imported from Kafka

This example shows you how to preview the export results.

Input Example

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": []
    }
}

Output Example

{
    "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"
    }
}

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

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
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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon