Tencent Cloud

Prev Next

키워드를 검색하세요

Recent Pages

문서

Download PDF

OpenKafkaConsumer

마지막 업데이트 시간:2024-04-15 19:58:34

PDF 다운로드

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to enable the Kafka consumption feature.

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: OpenKafkaConsumer.
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.
FromTopicId	Yes	String	Log Topic ID
Compression	No	Integer	Compression mode. Valid values: `0` (no compression); `2` (snappy); `3` (LZ4)
ConsumerContent	No	KafkaConsumerContent	Kafka consumer data format

3. Output Parameters

Parameter Name	Type	Description
TopicID	String	Topic Parameter used by KafkaConsumer during consumption
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 Enabling Consumption over Kafka

This example shows you how to enable consumption over Kafka.

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenKafkaConsumer
<Common request parameters>

{
    "FromTopicId": "a5ce0c9c-0690-44a5-bc79-5f2190626bd0",
    "Compression": 1
}

Output Example

{
    "Response": {
        "TopicID": "out-a5ce0c9c-0690-44a5-bc79-5f2190626bd0",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

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

Tencent Cloud CLI 3.0

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
AuthFailure	CAM signature/authentication error.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameter.ExportConflict	The export job already exists.
InvalidParameterValue	Incorrect parameter value.
MissingParameter	Missing parameter.
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.TopicNotExist	The log topic does not exist.

문의하기

고객의 업무에 전용 서비스를 제공해드립니다.

기술 지원

더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

연중무휴 24시간 전화 지원

tencent cloud

Recent Pages

OpenKafkaConsumer

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Enabling Consumption over Kafka

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

문제 해결에 도움이 되었나요?

문제 해결에 도움이 되었나요?

tencent cloud

가입하기

로그인

Recent Pages

OpenKafkaConsumer

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Enabling Consumption over Kafka

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

문제 해결에 도움이 되었나요?

문제 해결에 도움이 되었나요?