CreateConsumer

Last updated: 2025-11-21 20:32:28

CreateConsumer

Last updated: 2025-11-21 20:32:28

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to create a consumer group.

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: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	The ckafka cluster instance Id, which can be obtained through the DescribeInstances api.
GroupName	Yes	String	Consumer group name.
TopicName	No	String	Topic name. one of TopicName or TopicNameList must display a specified existing topic name.
TopicNameList.N	No	Array of String	Topic name list.

3. Output Parameters

Parameter Name	Type	Description
Result	JgwOperateResponse	Create consumer group returned 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.

4. Example

Example1 Creating a Consumer

This example shows you how to create a consumer.

Input Example

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

{
    "InstanceId": "ckafka-test",
    "TopicName": "topic-test",
    "GroupName": "group-test"
}

Output Example

{
    "Response": {
        "Result": {
            "ReturnMessage": "success",
            "ReturnCode": "ok",
            "Data": {
                "FlowId": 0,
                "RouteDTO": {
                    "RouteId": 0
                }
            }
        },
        "RequestId": "9e6d209b-69fd-4a00-b064-75131aa0a0f8"
    }
}

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
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud