Help Center/Distributed Message Service for Kafka/API Reference/APIs V2 (Recommended)/Managing Consumer Groups/Modifying Consumer Groups in Batches
Updated on 2026-03-16 GMT+08:00
View PDF

Modifying Consumer Groups in Batches

Function

This API is used to modify consumer groups in batches.

Calling Method

For details, see Calling APIs.

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. A maximum of 50 consumer groups can be modified in batches.

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

A maximum of 200 characters

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"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

Operation successful.

Error Codes

See Error Codes.

Parent Topic: Managing Consumer Groups