tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateConsumer

Last updated: 2024-04-15 19:58:46

    1. API Description

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

    This API is used to create a CKafka delivery task.

    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: CreateConsumer.
    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 to bind
    NeedContent No Boolean Whether to deliver log Metadata information, default is true.When NeedContent is true: Content field is valid.When NeedContent is false: Content field is invalid.
    Content No ConsumerContent Metadata to ship if NeedContent is true
    Ckafka No Ckafka CKafka information
    Compression No Integer Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4]

    3. Output Parameters

    Parameter Name Type Description
    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 Creating a CKafka Delivery Task

    After the CLS log is delivered to CKafka, you can perform real-time computing on the log before ingestion.

    Input Example

    POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConsumer
<Common request parameters>
{
    "TopicId": "xxx-xxx-xxx-xxx",
    "Ckafka": {
        "Vip": "10.123.123.123",
        "Vport": "8888",
        "InstanceId": "xxxxx",
        "InstanceName": "myname",
        "TopicId": "xxxxx",
        "TopicName": "xxxxx"
    },
    "Content": {
        "EnableTag": true,
        "MetaFields": [
            "__SOURCE__"
        ]
    },
    "NeedContent": true,
    "Compression": 0
}

    Output Example

    {
    "Response": {
        "RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx"
    }
}

    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.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.DbDuplication The unique key of database conflicts.
    LimitExceeded The quota limit has been reached.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy