Editing a Consumer Group

This API is used to edit a consumer group.

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

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine.
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.

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

Status code: 400

Table 3 Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Edit a consumer group. Type "desc" in the description.

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

{
  "group_name" : "test",
  "group_desc" : "desc"
}

None

Status Code	Description
204	Edited.
400	Editing failed.

Была ли эта статья полезна?