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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:OnsGroupConsumerUpdate。

GroupId String GID_test_groupId

需配置的 Group ID。

InstanceId String MQ_INST_111111111111_DOxxxxxx

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

ReadEnable Boolean true

设置读消息开关。

返回数据

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

为公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsGroupConsumerUpdate
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&ReadEnable=true
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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