华为云首页用户手册

设备接入 IOTDA-查询指定消息id的消息:响应参数

设备接入 IOTDA-查询指定消息id的消息:响应参数

时间：2024-06-28 09:24:59

设备接入 IOTDA

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
message_id	String	设备消息ID，用于唯一标识一条消息，在下发设备消息时由物联网平台分配获得。
name	String	消息名称,在下发消息时由用户指定。
message	Object	消息内容。
encoding	String	消息内容编码格式，取值范围none\|base64,默认值none, base64格式仅支持透传。
payload_format	String	有效负载格式，在消息内容编码格式为none时有效，取值范围standard\|raw，默认值standard（平台封装的标准格式），取值为raw时直接将消息内容作为有效负载下发。
topic	String	消息topic
properties	PropertiesDTO object	消息下行到设备的属性参数。
status	String	消息状态，包含PENDING，DELIVERED，FAILED和TIMEOUT，PENDING指设备不在线，消息被缓存起来，等设备上线之后下发； DELIVERED指消息发送成功；FAILED消息发送失败；TIMEOUT指消息在平台默认时间内（1天）还没有下发送给设备，则平台会将消息设置为超时，状态为TIMEOUT。
error_info	ErrorInfoDTO object	消息下发失败信息。
created_time	String	消息的创建时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。
finished_time	String	消息结束时间, "yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串，包含消息转换到DELIVERED和TIMEOUT两个状态的时间。

表4 PropertiesDTO
参数	参数类型	描述
correlation_data	String	参数说明：MQTT 5.0版本请求和响应模式中的相关数据，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的相关数据。取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
response_topic	String	参数说明：MQTT 5.0版本请求和响应模式中的响应主题，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的响应主题。取值范围：长度不超过128, 只允许字母、数字、以及_-?=$#+/等字符的组合。最大长度：128
user_properties	Array of UserPropDTO objects	参数说明：用户自定义属性，可选。用户可以通过该参数配置用户自定义属性。可以配置的最大自定义属性数量为20。

表5 UserPropDTO
参数	参数类型	描述
prop_key	String	参数说明：用户自定义属性键。取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
prop_value	String	参数说明：用户自定义属性值。取值范围：长度不超过128，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。

表6 ErrorInfoDTO
参数	参数类型	描述
error_code	String	参数说明：异常信息错误码，包含IOTDA.014016和IOTDA.014112。IOTDA.014016表示设备不在线；IOTDA.014112表示设备没有订阅topic。
error_msg	String	参数说明：异常信息说明，包含设备不在线和设备没有订阅topic说明。

上一篇：设备接入 IOTDA-查询指定消息id的消息:响应示例

下一篇：设备接入 IOTDA-查询指定消息id的消息:响应示例

设备接入 IOTDA-查询指定消息id的消息:响应参数

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题