QueryMqttTraceMessagePublish - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the trace of a message. If a message is not sent or received as expected, you can call this operation to view the message details to troubleshoot the issue. For example, you can query the time when the message is published and the client that publishes the message.

Operation description

Each successful call to the QueryMqttTraceMessagePublish operation increases the messaging transactions per second (TPS). 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 on the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console.	mqtt-cn-i7m26mf****
MsgId	string	Yes	The message ID.	AC1EC0030EAB78308DB16A3EC773****
BeginTime	long	Yes	The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1618646400000
EndTime	long	Yes	The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1621591200000

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID. You can use the ID to troubleshoot issues. This parameter is a common parameter.	69AD5550-BF22-438A-9202-A6E89185****
MessageTraceLists	array<object>	The message traces.
MessageTraceLists	object
Time	string	The time when the message was sent.	2021-05-21 15:08:19.210
Action	string	The action on the message. Valid values: pub_mqtt: indicates that the message was sent by an ApsaraMQ for MQTT client. pub_mq: indicates that the message was sent by an ApsaraMQ for RocketMQ client.	pub_mqtt
ActionCode	string	The returned code for the action on the message. Valid values: mqtt.trace.action.msg.pub.mqtt: This value is returned if the value of Action is pub_mqtt. mqtt.trace.action.msg.pub.mq: This value is returned if the value of Action is pub_mq.	mqtt.trace.action.msg.pub.mqtt
ActionInfo	string	The returned information for the action on the message. Valid values: Pub From Mqtt Client: This value is returned if the value of Action is pub_mqtt. Pub From MQ: This value is returned if the value of Action is pub_mq.	Pub From Mqtt Client
MsgId	string	The message ID.	AC1EC0030EAB78308DB16A3EC773BD95
ClientId	string	The ID of the client that sends the message.	GID_test@@@producer

Examples

Sample success responses

JSONformat

{
  "RequestId": "69AD5550-BF22-438A-9202-A6E89185****",
  "MessageTraceLists": [
    {
      "Time": "2021-05-21 15:08:19.210",
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ActionInfo": "Pub From Mqtt Client",
      "MsgId": "AC1EC0030EAB78308DB16A3EC773BD95",
      "ClientId": "GID_test@@@producer"
    }
  ]
}

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

No change history