CreateConsumerGroup

Download PDF

Last updated: 2025-12-02 10:55:15

CreateConsumerGroup

Last updated: 2025-12-02 10:55:15

Download PDF

1. API Description

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

Create consumer groups.

A maximum of 10000 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: CreateConsumerGroup.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	TDMQ RocketMQ instance ID. It can be obtained from the API DescribeFusionInstanceList or the console.
MaxRetryTimes	Yes	Integer	Maximum number of retries. Value range: 0 to 1000.
ConsumeEnable	Yes	Boolean	Whether to enable consumption.
ConsumeMessageOrderly	Yes	Boolean	Specifies whether to use ordered delivery. valid values: true. Concurrent delivery: false.
ConsumerGroup	No	String	Consumer group name. It can be obtained from ConsumeGroupItem returned by the API DescribeConsumerGroupList or from the console.
Remark	No	String	Remarks. Up to 128 characters are allowed.
TagList.N	No	Array of Tag	Tag list

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Cluster ID
ConsumerGroup	String	Specifies the consumer group name.
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 Create consumer groups.

This example shows you how to create a consumer group successfully.

Input Example

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

{
    "InstanceId": "rmq-72mo3a9o",
    "ConsumerGroup": "test_group",
    "MaxRetryTimes": 16,
    "ConsumeEnable": true,
    "ConsumeMessageOrderly": true,
    "Remark": "remark info"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "ConsumerGroup": "test_group",
        "InstanceId": "rmq-72mo3a9o",
        "RequestId": "58f60891-002f-4b8a-b71f-3767a645c28e"
    }
}

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.
FailedOperation.InstanceNotReady	Instance not ready. Please try again later.
ResourceNotFound.Instance	The instance does not exist.
UnsupportedOperation.ResourceAlreadyExists	Resource already exists. Please check and try again.

Was this page helpful?

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

Yes

Feedback

tencent cloud