调用OnsGroupConsumerUpdate配置指定Group ID对应的消费集群的消息读取权限。

使用说明

您可以使用本接口根据您指定的消息队列RocketMQ版地域(Region)以及Group ID名称,配置该Group ID读取消息的开关。本接口一般用于禁止特定Group ID读取消息的场景。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource(有命名空间)

Resource(无命名空间)

OnsGroupConsumerUpdate

mq:UpdateGroupConsumer

acs:mq:*:*:{instanceId}%{groupId}

acs:mq:*:*:{groupId}

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsGroupConsumerUpdate

系统规定参数。取值:OnsGroupConsumerUpdate

GroupId String GID_test_groupId

需配置的Group ID。

ReadEnable Boolean true

设置Group ID对应的消费者集群是否有读取消息权限。取值说明如下:

  • true:指定Group ID对应的消费者集群有读消息权限。
  • false:指定Group ID对应的消费者集群没有读消息权限。

默认值为true

InstanceId String MQ_INST_111111111111_DOxxxxxx

需配置的Group ID所对应的实例ID。

返回数据

名称 类型 示例值 描述
RequestId String A07E3902-B92E-44A6-B6C5-6AA111111****

公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupConsumerUpdate
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&ReadEnable=true
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsGroupConsumerUpdateResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsGroupConsumerUpdateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。