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. 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 CreateOrUpdateConsumerGroup objects	Consumer group list.

Table 3 CreateOrUpdateConsumerGroup
Parameter	Mandatory	Type	Description
name	No	String	Consumer group name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (\|), hyphens (-), and underscores (_).
brokers	No	Array of strings	Associated brokers. This parameter is mandatory only for RocketMQ 4.8.0 instances.
broadcast	No	Boolean	Whether to broadcast.
retry_max_time	No	Integer	Maximum number of retries (1 to 16 characters).
enabled	No	Boolean	Whether consumption is allowed.
consume_orderly	No	Boolean	Indicates whether to enable ordered consumption (This parameter is mandatory only for RocketMQ 5.x instances).
group_desc	No	String	Consumer group description (0 to 200 characters).

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
job_id	String	Job ID.

Example Requests

Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.

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

{
  "groups" : [ {
    "name" : "consumer-group-test",
    "enabled" : true,
    "broadcast" : false,
    "consume_orderly" : false,
    "retry_max_time" : 16
  } ]
}

Example Responses

Status code: 200

Consumer groups modified successfully.

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

Status Codes

Status Code	Description
200	Consumer groups modified successfully.

Error Codes

See Error Codes.

Parent topic: Consumer Group Management

Предыдущая статья

Creating a Consumer Group or Batch Deleting Consumer Groups

Следующая статья

Deleting a Consumer Group

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

Поддержка Юридические документы