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 about how to obtain it, 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	No	Boolean	Whether consumption is allowed.
broadcast	No	Boolean	Whether to broadcast.
brokers	No	Array of strings	List of associated brokers.
name	No	String	Consumer group name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (\|), hyphens (-), and underscores (_).
retry_max_time	No	Number	Maximum number of retries.
from_beginning	No	Boolean	Whether consumption starts from the beginning.

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,
  "from_beginning" : true,
  "broadcast" : true
}