Attribute
设备属性
被如下接口引用：CreateDevice。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Tags | Array of DeviceTag | 否 | 属性列表 |
BindDeviceInfo
子设备信息
被如下接口引用：DescribeGatewayBindDevices。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductId | String | 产品ID 示例值：UTY4QRLMQY |
| DeviceName | String | 设备名 示例值：dev-001 |
| Tags | Array of DeviceTag | 设备Tag |
| BindTime | Integer | 子设备绑定时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
BindProductInfo
子产品信息
被如下接口引用：DescribePrivateCABindedProducts。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductId | String | 产品ID 示例值：ABCDE12345 |
| ProductName | String | 产品名 示例值：ABCD |
BrokerSubscribe
代理订阅信息
被如下接口引用：CreateTopicPolicy, UpdateTopicPolicy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ProductId | String | 是 | 产品ID 示例值：UTY5QRLMQY |
| DeviceName | String | 是 | 设备名 示例值：dev-001 |
CLSLogItem
CLS日志
被如下接口引用：ListLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 日志内容 示例值：message |
| DeviceName | String | 设备名称 示例值：ABCD |
| ProductId | String | 产品ID 示例值：ABCDE12345 |
| RequestId | String | 请求ID 示例值：xxxxxxxxx |
| Result | String | 结果 示例值：SUCC |
| Scene | String | 模块 示例值：SHADOW |
| Time | String | 日志时间 示例值：2021-04-08 00:00:00 |
| UserId | String | 腾讯云账号 示例值：12345 |
CertInfo
X509证书信息
被如下接口引用：DescribePrivateCA, DescribePrivateCAs, DescribeProductCA。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CertName | String | 是 | 证书名称 示例值：IotHub |
| CertSN | String | 是 | 证书的序列号，16进制编码 示例值：5ff69e4c8afce5d6de8d395b34672944f5b4765a |
| IssuerName | String | 是 | 证书颁发着名称 示例值：CN=AAA,O=AAA,L=shenzhen,ST=guangdong,C=CN |
| Subject | String | 是 | 证书主题 示例值：CN=AAA,O=AAA,L=shenzhen,ST=guangdong,C=CN |
| CreateTime | Integer | 是 | 证书创建时间，秒级时间戳 示例值：1622619674 |
| EffectiveTime | Integer | 是 | 证书生效时间，秒级时间戳 示例值：1622448592 |
| ExpireTime | Integer | 是 | 证书失效时间，秒级时间戳 示例值：1653984592 |
| CertText | String | 是 | X509证书内容 示例值：-----BEGIN CERTIFICATE-----\nBz4FQdeV1+Xyf+Eg==\n-----END CERTIF |
DeviceInfo
设备详细信息
被如下接口引用：DescribeDevices。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceName | String | 设备名 示例值：ABCD |
| Online | Integer | 设备是否在线，0不在线，1在线 示例值：1 |
| LoginTime | Integer | 设备登录时间 示例值：1617801604 |
| Version | String | 设备版本 示例值：1.0.0 |
| DeviceCert | String | 设备证书，证书加密的设备返回 示例值：-----BEGIN CERTIFICATE----- MIIFGjCCBAKgAwIBAgIQCgRw0Ja8ihLIkKbf |
| DevicePsk | String | 设备密钥，密钥加密的设备返回 示例值：PSK |
| Tags | Array of DeviceTag | 设备属性 |
| DeviceType | Integer | 设备类型 示例值：5 |
| Imei | String | 国际移动设备识别码 IMEI 示例值：imei |
| Isp | Integer | 运营商类型 示例值：isp |
| ConnIP | Integer | IP地址 示例值：123124121 |
| LastUpdateTime | Integer | 设备最后更新时间 示例值：1617801604 |
| LoraDevEui | String | LoRa设备的dev eui 示例值：eui |
| LoraMoteType | Integer | LoRa设备的Mote type 示例值：2 |
| FirstOnlineTime | Integer | 首次上线时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
| LastOfflineTime | Integer | 最近下线时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
| CreateTime | Integer | 设备创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
| LogLevel | Integer | 设备日志级别 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CertState | Integer | 设备证书获取状态, 1 已获取过设备密钥，0 未获取过设备密钥 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| EnableState | Integer | 设备可用状态，0禁用，1启用 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Labels | Array of DeviceLabel | 设备标签 注意：此字段可能返回 null，表示取不到有效值。 |
| ClientIP | String | MQTT客户端IP地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| FirmwareUpdateTime | Integer | ota最后更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
| CreateUserId | Integer | 创建者 Uin 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| NBIoTDeviceID | String | NB IOT运营商处的DeviceID 示例值：12345 |
DeviceLabel
设备标签
被如下接口引用：DescribeDevice, DescribeDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 标签标识 示例值：key |
| Value | String | 是 | 标签值 示例值：value |
DeviceResourceInfo
设备资源详细信息
被如下接口引用：DescribeDeviceResource, DescribeDeviceResources。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductID | String | 产品ID 示例值：AAAAAAAAAA |
| ProductName | String | 产品名 示例值：test |
| Name | String | 资源名称 示例值：test |
| Md5 | String | 资源文件md5 示例值：bda2cc64487b0db7f53d689bccabde2d |
| Size | Integer | 资源文件大小 示例值：10 |
| UpdateTime | String | 资源更新时间 示例值：2021-01-03 17:04:05 |
| DeviceName | String | 设备名称 示例值：test |
| Status | Integer | 设备资源上传状态 示例值：0 |
| Percent | Integer | 设备资源上传百分比 示例值：70 |
DeviceTag
设备属性
被如下接口引用：CreateDevice, DescribeDevice, DescribeDevices, DescribeGatewayBindDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Tag | String | 是 | 属性名称 示例值：tagkey |
| Type | Integer | 是 | 属性值的类型，1 int，2 string 示例值：1 |
| Value | String | 是 | 属性的值 示例值：123 |
| Name | String | 否 | 属性描述名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：xyz |
DeviceUpdateStatus
设备固件更新状态
被如下接口引用：DescribeFirmwareTaskDevices。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceName | String | 设备名 示例值：dev-001 |
| LastProcessTime | Integer | 最后处理时间 示例值：1617801604 |
| Status | Integer | 状态 示例值：1 |
| ErrMsg | String | 错误消息 示例值：fail |
| Retcode | Integer | 返回码 示例值：-1 |
| DstVersion | String | 目标更新版本 示例值：1.0.1 |
| Percent | Integer | 下载中状态时的下载进度 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| OriVersion | String | 原版本号 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.0.0 |
| TaskId | Integer | 任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：132 |
FirmwareInfo
设备固件详细信息
被如下接口引用：ListFirmwares。
| 名称 | 类型 | 描述 |
|---|---|---|
| Version | String | 固件版本 示例值：1.0.1 |
| Md5sum | String | 固件MD5值 示例值：2f8222b4f275c4f18e69c34f66d2631b |
| CreateTime | Integer | 固件创建时间 示例值：1617801604 |
| ProductName | String | 产品名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：EQPOKD5111 |
| Name | String | 固件名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：固件名称 |
| Description | String | 固件描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：固件信息描述 |
| ProductId | String | 产品ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：EQPOKD5111 |
| FwType | String | 固件类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：mcu |
| CreateUserId | Integer | 创建者 Uin 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| UserDefined | String | 固件用户自定义配置信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"key1":"value1", "key2":"支持中文"} |
FirmwareTaskInfo
固件升级任务信息
被如下接口引用：DescribeFirmwareTasks, DescribeResourceTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：111 |
| Status | Integer | 任务状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Type | Integer | 任务类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| CreateTime | Integer | 任务创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
PayloadLogItem
内容日志项
被如下接口引用：ListLogPayload。
| 名称 | 类型 | 描述 |
|---|---|---|
| Uin | String | 账号id 示例值：10324534 |
| ProductId | String | 产品id 示例值：EQPOKD5111 |
| DeviceName | String | 设备名称 示例值：dev-001 |
| SrcType | String | 来源类型 示例值：device:DEFAULT_DEVICE |
| SrcName | String | 来源名称 示例值：mysrcname |
| Topic | String | 消息topic 示例值：EQPOKD5111/dev-001/data |
| PayloadFormatType | String | 内容格式类型 示例值：JSON |
| Payload | String | 内容信息 示例值：{"abc":123} |
| RequestId | String | 请求ID 示例值：ebea2fd8-0b8f-44b3-99ab-1b04fcfb6cbc |
| DateTime | String | 日期时间 示例值：2021-04-08 00:00:00 |
ProductInfo
产品详细信息
被如下接口引用：DescribeProducts。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductId | String | 产品ID 示例值：ABCDE2345 |
| ProductName | String | 产品名 示例值：IotHub |
| ProductMetadata | ProductMetadata | 产品元数据 |
| ProductProperties | ProductProperties | 产品属性 |
ProductMetadata
产品元数据
被如下接口引用：DescribeProduct, DescribeProducts。
| 名称 | 类型 | 描述 |
|---|---|---|
| CreationDate | Integer | 产品创建时间 示例值：12345 |
| CreateUserId | Integer | 创建者 Uin 示例值：0 |
| UserId | Integer | 账号 Uin 示例值：0 |
ProductProperties
产品属性
被如下接口引用：CreateProduct, DescribeProduct, DescribeProducts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ProductDescription | String | 否 | 产品描述 示例值：IotHub |
| EncryptionType | String | 否 | 加密类型，1表示证书认证，2表示签名认证。如不填写，默认值是1 示例值：2 |
| Region | String | 否 | 产品所属区域，目前只支持广州（gz） 示例值：gz |
| ProductType | Integer | 否 | 产品类型，各个类型值代表的节点-类型如下： 0 普通产品，2 NB-IoT产品，4 LoRa产品，3 LoRa网关产品，5 普通网关产品 默认值是0 示例值：5 |
| Format | String | 否 | 数据格式，取值为json或者custom，默认值是json 示例值：json |
| Platform | String | 否 | 产品所属平台，默认值是0 示例值：0 |
| ModelId | String | 否 | 产品绑定的物模型ID，-1表示不绑定 示例值：-1 |
| ModelName | String | 否 | 产品绑定的物模型名称 示例值：ipc |
| ProductKey | String | 否 | 产品密钥，suite产品才会有 示例值：grwgrer |
| RegisterType | Integer | 否 | 动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名 示例值：0 |
| ProductSecret | String | 否 | 动态注册产品密钥 示例值：key |
| RegisterLimit | Integer | 否 | RegisterType为2时，设备动态创建的限制数量 示例值：1000 |
| OriginProductId | String | 否 | 划归的产品，展示为源产品ID，其余为空 示例值：UTY6QRLMQY |
| PrivateCAName | String | 否 | 私有CA名称 示例值：caname |
| OriginUserId | Integer | 否 | 划归的产品，展示为源用户ID，其余为空 示例值：fag |
| DeviceLimit | Integer | 否 | 设备限制 示例值：1000 |
| ForbiddenStatus | Integer | 否 | 产品禁用状态 示例值：0 |
| AppEUI | String | 否 | LoRa产品运营侧APPEUI，只有LoRa产品需要填写 示例值：UTY6QRLMQY |
ProductResourceInfo
产品资源详细信息
被如下接口引用：DescribeProductResource, DescribeProductResources。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductID | String | 产品ID 示例值：EQPOKD5111 |
| ProductName | String | 产品名 示例值：dev-001 |
| Name | String | 资源名称 示例值：myname |
| Md5 | String | 资源文件md5 示例值：bda2cc64487b0db7f53d689bccabde2d |
| Size | Integer | 资源文件大小 示例值：10 |
| Description | String | 资源文件描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：mydescription |
| CreateTime | String | 资源创建时间 示例值：2021-01-03 17:04:05 |
ProductTaskInfo
产品级任务详细信息
被如下接口引用：DescribeProductTask, DescribeProductTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 任务ID 示例值：54521 |
| Type | Integer | 任务类型 0-批量创建设备类型 示例值：0 |
| State | Integer | 任务状态 0-创建中 1-待执行 2-执行中 3-执行失败 4-子任务部分失败 5-执行成功 示例值：0 |
| ParametersType | String | 任务参数类型 cosfile-文件输入 random-随机生成 示例值：cosfile |
| Parameters | String | 任务参数 示例值：gfadg |
| ResultType | String | 任务执行结果类型 cosfile-文件输出 errmsg-错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：cosfile |
| Result | String | 任务执行结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：succ |
| BatchCount | Integer | 子任务总个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| BatchOffset | Integer | 子任务已执行个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
| CreateTime | Integer | 任务创建时间 示例值：1617801604 |
| UpdateTime | Integer | 任务更新时间 示例值：1617801604 |
| CompleteTime | Integer | 任务完成时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617801604 |
ResetDeviceResult
重置设备状态结果
被如下接口引用：ResetDeviceState。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceName | String | 设备名 示例值：dev-001 |
| Success | Boolean | 是否成功 示例值：true |
| Reason | String | 失败原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：not exist |
SDKLogItem
SDK日志项
被如下接口引用：ListSDKLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductId | String | 产品ID 示例值：ABCDE12345 |
| DeviceName | String | 设备名称 示例值：ABCD |
| Level | String | 日志等级 示例值：DEBUG |
| DateTime | String | 日志时间 示例值：2021-04-08 00:00:00 |
| Content | String | 日志内容 示例值：12345 |
SearchKeyword
搜索关键词
被如下接口引用：DescribeFirmwareTaskDevices, DescribeFirmwareTasks, DescribeResourceTasks, ListFirmwares。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 搜索条件的Key 示例值：key |
| Value | String | 否 | 搜索条件的值 示例值：value |
StatusStatistic
状态统计信息
被如下接口引用：DescribeFirmwareTaskDistribution。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | Integer | 任务状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Total | Integer | 统计总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
TopicRuleInfo
规则详细信息
被如下接口引用：ListTopicRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleName | String | 规则名称 示例值：rule1 |
| Description | String | 规则描述 示例值：my description |
| CreatedAt | Integer | 创建时间 示例值：1741231767 |
| RuleDisabled | Boolean | 不生效 示例值：false |
| TopicPattern | String | 规则模式 示例值：topice1 |
TopicRulePayload
创建规则请求包体
被如下接口引用：CreateTopicRule, ReplaceTopicRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Sql | String | 是 | 规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== 示例值：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== |
| Actions | String | 否 | 行为的JSON字符串，大部分种类举例如下： [ { "republish": { "topic": "TEST/test" } }, { "forward": { "api": "http://127.0.0.1:8080", "token":"xxx" } }, { "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 | 否 | 规则描述 示例值：test |
| RuleDisabled | Boolean | 否 | 是否禁用规则 示例值：false |
