Modifying a Consumer Group

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

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.

**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.
consume_orderly	No	Boolean	Definition Whether to consume in order. Constraints This parameter is required only for RocketMQ 5.x instances. Range true: Yes false: No Default Value N/A
group_desc	No	String	Definition Consumer group description. Constraints N/A Range 0–200 Default Value N/A

Status code: 204

The specified consumer group is modified.

None

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
}

None

Status Code	Description
204	The specified consumer group is modified.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.