You can call this operation to configure the permission for a consumer group with a specified group ID to read messages.
Specifically, based on the specified region of your Message Queue for Apache RocketMQ instance and the group ID, you can specify whether to enable the group ID to read messages. This operation is applicable to scenarios where you want to forbid a specified group ID from reading messages.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | OnsGroupConsumerUpdate |
The operation that you want to perform. Set the value to OnsGroupConsumerUpdate. |
GroupId | String | Yes | GID_test_groupId |
The group ID for which you want to configure the permission to read messages. |
InstanceId | String | Yes | MQ_INST_111111111111_DOxxxxxx |
The ID of the Message Queue for Apache RocketMQ instance corresponding to the group ID. |
ReadEnable | Boolean | Yes | true |
Specifies whether to enable the permission to read messages. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | A07E3902-B92E-44A6-B6C5-6AA1111111799 |
The ID of the request. This is a common parameter. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=OnsGroupConsumerUpdate
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&ReadEnable=true
&<Common request parameters>
Sample success responses
XML
format
<OnsGroupConsumerUpdateResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA1111111799</RequestId>
</OnsGroupConsumerUpdateResponse>
JSON
format
{
"RequestId":"A07E3902-B92E-44A6-B6C5-6AA1111111799"
}
Error codes
For a list of error codes, visit the API Error Center.