VerifyConsumeMessage - - Alibaba Cloud Documentation Center

Verifies the consumption status of a message in a specific topic on a specific instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:VerifyConsumeMessage	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-i7m2vc1vx01
topicName	string	Yes	The topic name.	delay_topic
messageId	string	Yes	The message ID.	A9FE190A59AA421ED014743DFDBF017D
consumerGroupId	string	Yes	The ID of the consumer group.	TEST_FINANCE_STOCK_OUT_GROUP
clientId	string	Yes	The client ID.	zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns

Response parameters

Parameter	Type	Description	Example
	object	The result.
requestId	string	The request ID.	5304143F-AB0E-5AB4-A227-7C5489216FD5
success	boolean	Indicates whether the request was successful.	true
data	boolean	The returned data.	true
code	string	The error code.	Topic.NotFound
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-23	The internal configuration of the API is changed, but the call is not affected	View Change Details