Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Managing Consumer Groups/ Modifying All Consumer Groups
Updated on 2025-05-21 GMT+08:00
View PDF

Modifying All Consumer Groups

Function

This API is used to modify all consumer groups.

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

group_name

No

String

Consumer group name.

group_desc

No

String

Consumer group description.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Background task ID.

Example Requests

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

{
  "group_name" : "test",
  "group_desc" : "this is a test group"
}

Example Responses

Status code: 200

Successful

{
  "job_id" : "8a2c259182ab0e9d0182ab1882560010"
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent Topic: Managing Consumer Groups