調用該接口通過消息ID查詢設備上下行消息的詳情,包括消息的內容、消息的產生時間、發送消息的Topic等。
使用說明
QoS=0和QoS=1消息的最大存儲時間分別為1天和7天。調用本接口前,請確認查詢的是存儲時間內的消息。否則,查詢消息會失敗。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為10。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | QueryMessageInfo | 系統規定參數。取值:QueryMessageInfo。 |
UniMsgId | String | 是 | 323455*** | 物聯網平臺為消息生成的唯一標識ID。 您可登錄物聯網平臺控制臺,在監控運維 > 日志服務頁面,獲取消息ID信息。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t*** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見如何獲取實例ID。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
Message | Struct | 調用成功后,返回的消息詳情。 |
|
GenerateTime | Long | 1624419431000 | 消息產生的時間,單位為毫秒。 |
MessageContent | String | eyJsYXN0VGltZSI6IjIwMjEtMDYtMjQgMTY6Mj** | 消息原文轉換成二進制數據,并進行Base64編碼后的消息內容。 |
MqttProperties | Array of MqttProperty | 使用MQTT 5.0版本通信協議時,配置的特性屬性列表。詳細內容,請參見MQTT 5.0特性。 |
|
Key | String | attrkey | 屬性名稱。 |
Value | String | attrvalue | 屬性值。 |
TopicFullName | String | /a1Q5XoY****/device1/user/get | 消息所屬的Topic。 |
TransformedMessageContent | String | test | 產品配置了消息解析時,轉換成功后的消息內容。 |
TransformedTopicFullName | String | /w******j/device01/user/testmsg | 產品配置了消息解析時,轉換成功后的Topic。 |
UniMsgId | String | 323455*** | 物聯網平臺為消息生成的唯一標識ID。 |
UserProperties | Array of UserProperty | 使用MQTT 5.0版本通信協議時,用戶自定義的屬性列表信息。 |
|
Key | String | key1 | 用戶自定義屬性的Key字段。 |
Value | String | value1 | 用戶自定義屬性Key字段對應的值。 |
RequestId | String | BB71E443-4447-4024-A000-EDE09922891E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryMessageInfo
&UniMsgId=323455***
&<公共請求參數>
正常返回示例
XML
格式
<QueryMessageInfoResponse>
<RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
<Message>
<MessageContent>eyJsYXN0VGltZSI6IjIwMjEtMDYtMjQgMTY6Mj**</MessageContent>
<GenerateTime>1624419431000</GenerateTime>
<UniMsgId>323455***</UniMsgId>
<TopicFullName>/a1Q5XoY****/device1/user/get</TopicFullName>
<UserProperties>
<Value>value1</Value>
<Key>key1</Key>
</UserProperties>
</Message>
<Success>true</Success>
</QueryMessageInfoResponse>
JSON
格式
{
"RequestId": "BB71E443-4447-4024-A000-EDE09922891E",
"Message": {
"MessageContent": "eyJsYXN0VGltZSI6IjIwMjEtMDYtMjQgMTY6Mj**",
"GenerateTime": 1624419431000,
"UniMsgId": "323455***",
"TopicFullName": "/a1Q5XoY****/device1/user/get",
"UserProperties": [{
"Value": "value1",
"Key": "key1"
}]
},
"Success": true
}