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	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
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	List of associated brokers.
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

None

Example Requests

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

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

{
  "name" : "consumer-group-test",
  "enabled" : true,
  "retry_max_time" : 16,
  "broadcast" : true
}