Queries messages on a device within a specific period of time. If a message is not sent or received as expected, you can call this operation to query the messaging status of the message to efficiently troubleshoot issues.
Operation description
- Each successful call to the QueryMqttTraceMessageOfClient 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
Authorization information
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**** |
ClientId | string | Yes | The client ID of the device whose messages you want to query. | GID_test@@@producer |
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 |
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 |
Reverse | boolean | No | Specifies whether the returned results are displayed in reverse chronological order. Valid values:
If this parameter is not specified, the returned results are displayed in order of the time when messages are sent or received. | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"CurrentPage": 1,
"RequestId": "B096B9D6-62F3-4567-BB59-58D1362E****",
"PageSize": 10,
"Total": 5,
"MessageOfClientList": [
{
"Time": "2021-05-21 15:08:19.234",
"Action": "pub_mqtt",
"ActionCode": "mqtt.trace.action.msg.pub.mqtt",
"ActionInfo": "Pub From Mqtt Client",
"MsgId": "AC1EC0030EAB78308DB16A3EC773****",
"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 |
---|