数据结构

最近更新时间:2019-03-08 17:36:44

Attribute

设备属性

被如下接口引用:CreateDevice。

名称 类型 必选 描述
Tags Array of DeviceTag 属性列表

BatchPublishMessage

批量发消息请求

被如下接口引用:CreateTask。

名称 类型 必选 描述
Topic String 消息发往的主题。为 Topic 权限中去除 ProductID 和 DeviceName 的部分,如 “event”
Payload String 消息内容

BatchUpdateShadow

批量更新设备影子任务

被如下接口引用:CreateTask。

名称 类型 必选 描述
Desired String 设备影子的期望状态,格式为 Json 对象序列化之后的字符串

BrokerSubscribe

代理订阅信息

被如下接口引用:CreateTopicPolicy、UpdateTopicPolicy。

名称 类型 必选 描述
ProductId String 产品ID
DeviceName String 设备名

DeviceInfo

设备详细信息

被如下接口引用:DescribeDevices。

名称 类型 描述
DeviceName String 设备名
Online Integer 设备是否在线,0不在线,1在线
LoginTime Integer 设备登录时间
Version String 设备版本
DeviceCert String 设备证书,证书加密的设备返回
DevicePsk String 设备密钥,密钥加密的设备返回
Tags Array of DeviceTag 设备属性
DeviceType Integer 设备类型
Imei String IMEI
Isp Integer 运营商类型
NbiotDeviceID String NB IOT运营商处的DeviceID
ConnIP Integer IP地址
LastUpdateTime Integer 设备最后更新时间
LoraDevEui String LoRa设备的dev eui
LoraMoteType Integer LoRa设备的Mote type
FirstOnlineTime Integer 首次上线时间
注意:此字段可能返回 null,表示取不到有效值。
LastOfflineTime Integer 最近下线时间
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 设备创建时间
注意:此字段可能返回 null,表示取不到有效值。
LogLevel Integer 设备日志级别
注意:此字段可能返回 null,表示取不到有效值。

DeviceTag

设备属性

被如下接口引用:CreateDevice、DescribeDevice、DescribeDevices。

名称 类型 必选 描述
Tag String 属性名称
Type Integer 属性值的类型,1 int,2 string
Value String 属性的值

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

被如下接口引用:DescribeProducts。

名称 类型 必选 描述
Name String 过滤键的名称
Values Array of String 一个或者多个过滤值

MultiDevicesInfo

创建设备时返回的设备信息

被如下接口引用:DescribeMultiDevices。

名称 类型 描述
DeviceName String 设备名
DevicePsk String 对称加密密钥,base64 编码,采用对称加密时返回该参数
DeviceCert String 设备证书,采用非对称加密时返回该参数
DevicePrivateKey String 设备私钥,采用非对称加密时返回该参数,腾讯云为用户缓存起来,其生命周期与任务生命周期一致
Result Integer 错误码
ErrMsg String 错误信息

ProductInfo

产品详细信息

被如下接口引用:DescribeProducts。

名称 类型 描述
ProductId String 产品ID
ProductName String 产品名
ProductMetadata ProductMetadata 产品元数据
ProductProperties ProductProperties 产品属性

ProductMetadata

产品元数据

被如下接口引用:DescribeProducts。

名称 类型 描述
CreationDate Integer 产品创建时间

ProductProperties

产品属性

被如下接口引用:CreateProduct、DescribeProducts。

名称 类型 必选 描述
ProductDescription String 产品描述
EncryptionType String 加密类型,1表示证书认证,2表示签名认证。如不填写,默认值是1
Region String 产品所属区域,目前只支持广州(gz)
ProductType Integer 产品类型,各个类型值代表的节点-类型如下:
0 普通产品,2 NB-IoT产品,4 LoRa产品,3 LoRa网关产品,5 普通网关产品 默认值是0
Format String 数据格式,取值为json或者custom,默认值是json
Platform String 产品所属平台,默认值是0
Appeui String LoRa产品运营侧APPEUI,只有LoRa产品需要填写
ModelId String 产品绑定的物模型ID,-1表示不绑定
ModelName String 产品绑定的物模型名称
ProductKey String 产品密钥,suite产品才会有

Task

任务描述细节

被如下接口引用:CreateTask。

名称 类型 必选 描述
UpdateShadowTask BatchUpdateShadow 批量更新影子任务的描述细节,当 taskType 取值为 “UpdateShadow” 时,此字段必填。描述见下 BatchUpdateShadow
PublishMessageTask BatchPublishMessage 批量下发消息任务的描述细节,当 taskType 取值为 “PublishMessage” 时,此字段必填。描述见下 BatchPublishMessage

TaskInfo

任务列表详细信息

被如下接口引用:DescribeTasks。

名称 类型 描述
Type String 任务类型,目前取值为 “UpdateShadow” 或者 “PublishMessage”
Id String 任务 ID
ProductId String 产品 ID
Status Integer 状态。1表示等待处理,2表示调度处理中,3表示已完成,4表示失败,5表示已取消
CreateTime Integer 任务创建时间,Unix 时间戳
UpdateTime Integer 最后任务更新时间,Unix 时间戳
RetCode Integer 返回的错误码
ErrMsg String 返回的错误信息

TopicRulePayload

创建规则请求包体

被如下接口引用:CreateTopicRule、ReplaceTopicRule。

名称 类型 必选 描述
Sql String 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
Actions String 行为的JSON字符串,大部分种类举例如下:
[{"republish":{"topic":"TEST/test"}},{"forward":{"api":"http://127.0.0.1:8080"}},{"ckafka":{"instance":{"id":"ckafka-test","name":""},"topic":{"id":"topic-test","name":"test"},"region":"gz"}},{"cmqqueue":{"queuename":"queue-test-TEST","region":"gz"}},{"mysql":{"instanceid":"cdb-test","region":"gz","username":"test","userpwd":"*****","dbname":"d_mqtt","tablename":"t_test","fieldpairs":[{"field":"test","value":"test"}],"devicetype":"CUSTOM"}}]
Description String 规则描述
RuleDisabled Boolean 是否禁用规则