Help Center/ Distributed Message Service for RocketMQ/ API Reference (ME-Abu Dhabi Region)/ APIs V2 (Recommended)/ Consumer Group Management/ Modifying a Consumer Group
Updated on 2023-05-06 GMT+08:00
View PDF
Share

Modifying a Consumer Group

Function

This API is used to modify parameters of a specified consumer group.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

group

Yes

String

Consumer group name.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

enabled

No

Boolean

Whether consumption is allowed.

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

None

Example Requests

Modifying a consumer group

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

{
  "name" : "consumer-group-test",
  "enabled" : true,
  "retry_max_time" : 16,
  "from_beginning" : true,
  "broadcast" : true
}

Example Responses

None

Status Codes

Status Code

Description

204

The operation is successful.

Error Codes

See Error Codes.