Query message delivery trace with QueryMqttTraceMessageSubscribe - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:QueryMqttSubTrace

none

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

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	No	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	No	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	integer	Yes	The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1621936800000
EndTime	integer	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 elements

Element	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	integer	The returned delivery traces.	2
MessageTraceLists	array<object>	The delivery trace of the queried message.
	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

Success response

JSON format

{
  "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
400	MqttOwnerCheckError	Failed to validate the instance permission
400	MqttInstanceNotFound	Specified instance is not found
403	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.