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