Modifying All Consumer Groups

Function

This API is used to modify all consumer groups.

URI

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.

Request Parameters

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

**Table 3** GroupCreateReq
Parameter	Mandatory	Type	Description
group_name	No	String	Definition Consumer group name. Constraints N/A Range N/A Default Value N/A
group_desc	No	String	Definition Consumer group description. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 204

Operation successful.

None

Example Requests

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

{
  "groups" : [ {
    "group_name" : "test_group_1",
    "group_desc" : "group description for test_group_1"
  }, {
    "group_name" : "test_group_2",
    "group_desc" : "group description for test_group_2"
  } ]
}