Batch Modifying Consumer Groups

Function

This API is used to modify consumer groups in batches.

URI

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

**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.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
groups	No	Array of CreateOrUpdateConsumerGroup objects	Consumer group list.

**Table 3** CreateOrUpdateConsumerGroup
Parameter	Mandatory	Type	Description
name	No	String	Consumer group name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (\|), hyphens (-), and underscores (_).
brokers	No	Array of strings	List of associated brokers.
broadcast	No	Boolean	Whether to broadcast.
retry_max_time	No	Integer	Maximum number of retries (1 to 16 characters).
enabled	No	Boolean	Whether consumption is allowed.
consume_orderly	No	Boolean	Whether to enable orderly consumption.
group_desc	No	String	Consumer group description (0 to 200 characters). Minimum: 0 Maximum: 200

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Job ID.

Example Requests

Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.

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

{
  "groups" : [ {
    "name" : "consumer-group-test",
    "enabled" : true,
    "broadcast" : false,
    "consume_orderly" : false,
    "retry_max_time" : 16
  } ]
}

Example Responses

Status code: 200

Consumer groups modified successfully.

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

Status Codes

Status Code	Description
200	Consumer groups modified successfully.

Error Codes

See Error Codes.

Parent topic: Consumer Group Management

Previous topic: Creating a Consumer Group or Batch Deleting Consumer Groups

Next topic: Deleting a Consumer Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot