ModifyConsumerGroup

最后更新时间：2026-01-13 21:52:13

ModifyConsumerGroup

最后更新时间： 2026-01-13 21:52:13

1. API Description

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

Modify consumer group attributes.

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: ModifyConsumerGroup.
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.
ConsumerGroup	No	String	Consumer group name. It can be obtained from ConsumeGroupItem returned by the API DescribeConsumerGroupList or from the console.
ConsumeEnable	No	Boolean	Whether to enable consumption.
ConsumeMessageOrderly	No	Boolean	Specifies whether to use ordered delivery. valid values: true. Concurrent delivery: false.
MaxRetryTimes	No	Integer	Maximum number of retries. Value range: 0 to 1000.
Remark	No	String	Remarks. Up to 128 characters are allowed.

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 Modify consumer group attributes.

This example shows you how to modify consumer group attributes successfully.

Input Example

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

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

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "239a3769-8dc6-41e9-bc01-67be452db5a3"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud