Configures the permission for a consumer group with a specified group ID to read messages.
Usage notes
You can call this operation to configure the permission for a consumer group to read messages based on a specified region of Message Queue for Apache RocketMQ and a specified group ID. This operation is applicable to scenarios where a specific group ID is forbidden from reading messages.
QPS limit
The queries-per-second (QPS) limit on this operation is 10 per user. Throttling is triggered when the number of calls to this operation per second exceeds the QPS limit. Throttling may affect your business. Therefore, call this operation based on your needs. For more information, see QPS limits.
Authorization information
By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after they are authorized to use it. The following table lists the authorization information of this operation. For more information, see Policies and examples.
API |
Action |
Resource (with namespace) |
Resource (without namespace) |
---|---|---|---|
OnsGroupConsumerUpdate |
mq:UpdateGroupConsumer |
acs:mq:*:*:{instanceId}%{groupId} |
acs:mq:*:*:{groupId} |
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 instance where the group ID you want to configure is located. |
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-6AA111111**** |
The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating. |
Examples
Sample requests
http(s)://ons.cn-hangzhou.aliyuncs.com/? 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-6AA111111****</RequestId>
</OnsGroupConsumerUpdateResponse>
JSON
format
{
"RequestId":"A07E3902-B92E-44A6-B6C5-6AA111111****"
}
Error codes
For a list of error codes, visit the API Error Center.