Modifying All Consumer Groups

Updated on 2025-03-07 GMT+08:00

View PDF

This API is used to modify all consumer groups.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Engine.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
group_name	No	String	Consumer group name.
group_desc	No	String	Consumer group description.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Background task ID.

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

Status code: 200

Successful

{
  "job_id" : "8a2c259182ab0e9d0182ab1882560010"
}

Status Code	Description
200	Successful

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

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