All Products
Document Center

ApsaraMQ for RocketMQ:OnsGroupConsumerUpdate

Last Updated:Jul 21, 2023

Configures read permissions on messages for a consumer group that is identified by a group ID.

Operation Description

NoteAPI operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

You can call this operation to configure the permissions for a consumer group to read messages based on a specified region of ApsaraMQ for RocketMQ and a specified group ID. You can call this operation in scenarios in which you want to forbid consumers in a specific group from reading messages.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • Ons
  • Ons

Request parameters


The ID of the consumer group for which you want to configure read permissions.


Specifies whether to authorize the consumer group to read messages. Valid values:

  • true: The consumer group can read messages.
  • false: The consumer group cannot read messages.

Default value: true.


The ID of the instance to which the consumer group you want to configure belongs.


Response parameters


The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.



Sample success responses


  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"

Error codes

For a list of error codes, visit the Service error codes.