查詢指定設(shè)備在一定時間段內(nèi)的消息列表。當消息的收發(fā)不符合預(yù)期時,您可以通過該接口查看消息的收發(fā)狀態(tài)等軌跡信息,幫助您快速定位異常原因。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MqttRegionId | string | 是 | 云消息隊列 MQTT 版實例地域(Region)的 ID。請參見服務(wù)接入點。 | cn-hangzhou |
InstanceId | string | 是 | 云消息隊列 MQTT 版實例的 ID,一定要和客戶端實際使用的實例 ID 匹配。您可以在控制臺實例詳情頁面的基礎(chǔ)信息區(qū)域查看。 | mqtt-cn-i7m26mf**** |
ClientId | string | 是 | 需要查詢消息列表的設(shè)備的 Client ID。 | GID_test@@@producer |
BeginTime | long | 是 | 查詢范圍的起始時間戳。單位:毫秒。 | 1618646400000 |
EndTime | long | 是 | 查詢范圍的終止時間戳。單位:毫秒。 | 1621591200000 |
CurrentPage | integer | 是 | 當前取第幾頁消息,從 1 開始遞增。若輸入?yún)?shù)大于總頁數(shù),則返回結(jié)果為空。 | 1 |
PageSize | integer | 是 | 分頁查詢,每頁最多顯示的消息數(shù)量,最小 1 條,最多 100 條。 | 5 |
Reverse | boolean | 否 | 返回結(jié)果是否倒序顯示。取值說明如下:
若不輸入,則返回結(jié)果默認按照消息發(fā)送或消費的時間順序顯示。 | false |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"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"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
404 | ApiNotSupport | The specified API is not supported. | 當前接口不支持,請檢查。 |
500 | SystemOverFlow | An error occurred while processing your request. Please try again. | 系統(tǒng)限流,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|
控制臺操作
除了調(diào)用 QueryMqttTraceMessageOfClient 接口,您還可以通過微消息隊列 MQTT 版控制臺查看設(shè)備的消息列表。具體操作,請參見消息軌跡查詢。