All Products
Search
Document Center

OnsGroupConsumerUpdate

Last Updated: Apr 01, 2019

OnsGroupConsumerUpdate

You can call this operation to configure the read permission on messages for a consumption cluster based on the specified group ID.

Description

You can call this operation to configure the message read permission of a group ID based on the specified RocketMQ region and group ID. The operation is used for scenarios where a specific group ID is not allowed to read messages.

Request parameters

Name Type Required Description
PreventCache Long Yes The parameter used for CSRF verification, which can be set to the current system time. Unit: ms
InstanceId String No The ID of the instance.
GroupId String Yes The group ID for which you want to configure the message read permission.
ReadEnable Boolean Yes Indicates whether message reading is enabled.

Response parameters

Name Type Description
RequestId String A common parameter. Each request has a unique ID.
HelpUrl String A help link.

Examples

For more information about sample codes, see API sample code and endpoints.