VerifyConsumeMessage - 消息消费验证_云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

验证指定实例下指定主题的消息消费状态。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:VerifyConsumeMessage	update	Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}	无	无

请求语法

POST /instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-i7m2vc1vx01
topicName	string	是	主题名称。	delay_topic
messageId	string	是	消息 ID。	A9FE190A59AA421ED014743DFDBF017D
consumerGroupId	string	是	消费者分组 ID。	TEST_FINANCE_STOCK_OUT_GROUP
clientId	string	是	客户端 ID。	zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	5304143F-AB0E-5AB4-A227-7C5489216FD5
success	boolean	是否成功	true
data	boolean	返回结果	true
code	string	错误码	Topic.NotFound
message	string	错误信息	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "5304143F-AB0E-5AB4-A227-7C5489216FD5",
  "success": true,
  "data": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-23	API 内部配置变更，不影响调用	查看变更详情