调用该接口查询设备上下行消息的详情,包括消息的内容、消息的产生时间、发送消息的Topic等。

限制说明

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryMessageInfo

系统规定参数。取值:QueryMessageInfo。

UniMsgId String 323455***

物联网平台为消息生成的唯一标识ID。

您可登录物联网平台控制台,在监控运维 > 日志服务页面,获取消息ID信息。

IotInstanceId String iot-cn-0pp1n8t***

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

Message Struct

调用成功后,返回的消息详情。

GenerateTime Long 1624419431000

消息产生的时间,单位为毫秒。

MessageContent String eyJsYXN0VGltZSI6IjIwMjEtMDYtMjQgMTY6Mj**

消息原文转换成二进制数据,并进行Base64编码后的消息内容。

TopicFullName String /a1Q5XoY****/device1/user/get

消息所属的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

是否调用成功。

  • true:调用成功,表示查询消息详情成功。
  • false:调用失败,表示查询消息详情失败。

示例

请求示例

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
}