QueryMqttTraceMessageSubscribe - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the delivery trace of a message. If a message is not sent or received as expected, you can call this operation to view the details about the message. For example, you can query the clients that subscribe to the message and the time when the message is delivered. This operation helps you locate the problem and identify the cause of the problem.

Operation description

Each successful call to the QueryMqttTraceMessageSubscribe operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.
You can call this operation up to 500 times per second per account. If the limit is exceeded, throttling is triggered. This may affect your business. We recommend that you take note of this limit when you call this operation. For more information, see Limits on QPS.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MqttRegionId	string	Yes	The ID of the region where the ApsaraMQ for MQTT instance resides. For more information, see Endpoints .	cn-hangzhou
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance. The ID must be consistent with the ID of the instance that the ApsaraMQ for MQTT client uses. You can view the instance ID in the Basic Information section of the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console.	mqtt-cn-i7m26mf****
Reverse	boolean	Yes	Specifies whether the returned results are displayed in reverse chronological order. Valid values: true: The returned results are displayed in reverse order of the time when messages are delivered. This means that the latest consumed message is displayed as the first entry and the earliest consumed message is displayed as the last entry. false: The returned results are displayed in order of the time when messages are delivered. This means that the earliest consumed message is displayed as the first entry and the latest consumed message is displayed as the last entry. If you do not specify this parameter, the returned results are displayed in order of time when messages are delivered.	false
ClientId	string	Yes	The ID of the client that subscribes to the message. If you do not specify this parameter, the IDs of all clients that subscribe to the message are returned.	GID_test@@@consumer
BeginTime	long	Yes	The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1621936800000
EndTime	long	Yes	The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1618646400000
CurrentPage	integer	Yes	The number of the page to return. Pages start from page 1. If the input parameter value is greater than the total number of pages, the returned result is empty.	1
PageSize	integer	Yes	The number of entries to return on each page. Valid values: 1 to 100.	5
MsgId	string	Yes	The message ID.	AC1EC1B33D5978308DB17F3245E4****

Response parameters

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The unique ID that the system generates for the request. You can use the ID to troubleshoot issues. This parameter is a common parameter.	4E685844-ADAF-4D85-9EAC-F9471E8C****
PageSize	integer	The number of entries returned per page.	5
Total	long	The returned delivery traces.	2
MessageTraceLists	array<object>	The delivery trace of the queried message.
MessageTraceLists	object
Time	string	The time when the message was delivered.	2021-05-25 16:46:41.274
Action	string	The action on the message. Valid values: sub: The ApsaraMQ for MQTT client subscribes to the message. push_offline: The ApsaraMQ for MQTT broker pushes the offline message to the ApsaraMQ for MQTT client.	sub
ActionCode	string	The code returned for the action on the message. Valid values: mqtt.trace.action.msg.sub: The value that is returned if the value of Action is sub. mqtt.trace.action.msg.push.offline: The value that is returned if the value of Action is push_offline.	mqtt.trace.action.msg.sub
ActionInfo	string	The returned information for the action on the message. Valid values: Push To Mqtt Client: The value that is returned if the value of Action is sub. Push Offline Msg To Mqtt Client: The value that is returned if the value of Action is push_offline.	Push To Mqtt Client
MsgId	string	The message ID.	AC1EC1B33D5978308DB17F3245E4****
ClientId	string	The ID of the client that subscribes to the message.	GID_test@@@consumer

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "4E685844-ADAF-4D85-9EAC-F9471E8C****",
  "PageSize": 5,
  "Total": 2,
  "MessageTraceLists": [
    {
      "Time": "2021-05-25 16:46:41.274",
      "Action": "sub",
      "ActionCode": "mqtt.trace.action.msg.sub",
      "ActionInfo": "Push To Mqtt Client",
      "MsgId": "AC1EC1B33D5978308DB17F3245E4****",
      "ClientId": "GID_test@@@consumer"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
404	ApiNotSupport	The specified API is not supported.
500	SystemOverFlow	An error occurred while processing your request. Please try again.

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

Change history

Change time	Summary of changes	Operation
2024-03-20	The Error code has changed	View Change Details