Files

chenjunjie 719d8b18de RocketMQ API 20250723 version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>

2026-03-18 20:25:09 +00:00

7.7 KiB

Raw Blame History

Modifying a Consumer Group

Function

This API is used to modify parameters of a specified consumer group.

URI

PUT /v2/{project_id}/instances/{instance_id}/groups/{group}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A
group	Yes	String	Consumer group name.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	Whether a message can be consumed.
broadcast	Yes	Boolean	Whether to broadcast.
brokers	No	Array of strings	Definition List of associated brokers. Constraints N/A Range N/A Default Value N/A
name	No	String	Consumer group whose parameters are to be modified. (The consumer group name cannot be modified.)
retry_max_time	Yes	Integer	Maximum number of retries. Value range: 1 to 16.

Response Parameters

Status code: 204

The specified consumer group is modified.

None

Example Requests

Changing consumer-group-test's max. retries to 16

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}

{
  "enabled" : true,
  "retry_max_time" : 16,
  "broadcast" : true
}

Example Responses

None

Status Codes

Status Code	Description
204	The specified consumer group is modified.

Error Codes

See Error Codes.

Parent topic: Consumer Group Management

7.7 KiB Raw Blame History