Updated on 2022-09-14 GMT+08:00

Batch Modifying Consumer Groups

Function

This API is used to modify consumer groups in batches.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

groups

No

Array of ConsumerGroup objects

Consumer group list. This parameter is used when consumer groups are deleted in batches.

Table 3 ConsumerGroup

Parameter

Mandatory

Type

Description

enabled

No

Boolean

Enabled or not.

broadcast

No

Boolean

Whether to broadcast.

brokers

No

Array of strings

List of associated brokers.

name

No

String

Consumer group name.

retry_max_time

No

Number

Maximum number of retries.

from_beginning

No

Boolean

Whether consumption starts from the beginning.

Response Parameters

Status code: 204

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Job ID.

Example Requests

{
  "groups" : [ {
    "enabled" : true,
    "broadcast" : false,
    "brokers" : [ "broker-0" ],
    "name" : "group1",
    "retry_max_time" : 16,
    "from_beginning" : false
  } ]
}

Example Responses

Status code: 204

Consumer groups modified successfully.

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

Status Codes

Status Code

Description

204

Consumer groups modified successfully.

Error Codes

See Error Codes.