数据结构

最近更新时间:2024-10-12 13:22:27

我的收藏

AppDeviceInfo

云api直接绑定设备出参

被如下接口引用:DirectBindDeviceInFamily。

名称 类型 描述
DeviceId String 产品ID/设备名
示例值:fsdf
ProductId String 产品ID
示例值:sdf
DeviceName String 设备名
示例值:sdf
AliasName String 设备别名
示例值:sdfsdf
IconUrl String icon地址
示例值:sdfsdf
FamilyId String 家庭ID
示例值:sdffsd
RoomId String 房间ID
示例值:sdfds
DeviceType Integer 设备类型
示例值:0
CreateTime Integer 创建时间
示例值:23423423
UpdateTime Integer 更新时间
示例值:234234234

AuthMiniProgramAppInfo

授权小程序信息

被如下接口引用:GetAuthMiniProgramAppList。

名称 类型 必选 描述
MiniProgramAppId String 小程序APPID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12sws
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:19856567
MiniProgramName String 小程序名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:app
LicenseNum Integer 激活码数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IotAppId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:app123
IotAppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:Test名

BatchProductionInfo

获取返回列表的详情。

被如下接口引用:GetBatchProductionsList。

名称 类型 描述
BatchProductionId String 量产ID
ProductId String 产品ID
BurnMethod Integer 烧录方式
CreateTime Integer 创建时间
ProductName String 产品名称

BindDeviceInfo

BindDeviceInfo

被如下接口引用:DescribeGatewayBindDevices。

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

BindProductInfo

绑定、未绑定产品详细信息

被如下接口引用:DescribeBindedProducts, DescribeGatewaySubProducts。

名称 类型 描述
ProductId String 产品ID。
示例值:productud
ProductName String 产品名称。
示例值:productname
ProjectId String 产品所属项目ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:projectid
DataProtocol Integer 物模型类型。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CategoryId Integer 产品分组模板ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProductType Integer 产品类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NetType String 连接类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:else
DevStatus String 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:dev
ProductOwnerName String 产品拥有者名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

CamTag

标签数据结构

被如下接口引用:DescribeTopicRule。

名称 类型 必选 描述
TagKey String 标签键
注意:此字段可能返回 null,表示取不到有效值。
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。

CloudStorageAIServiceTask

云存 AI 服务任务信息

被如下接口引用:DescribeCloudStorageAIServiceTask, DescribeCloudStorageAIServiceTasks, InvokeExternalSourceAIServiceTask。

名称 类型 描述
TaskId String 云存 AI 服务任务 ID
示例值:fb066d7a-baac-4706-acda-058f56f82759
ProductId String 产品 ID
示例值:TQBDY6RPI9
DeviceName String 设备名称
示例值:cs_112114601_2
ChannelId Integer 通道 ID
示例值:0
ServiceType String 云存 AI 服务类型。可能取值:

- RealtimeObjectDetect:目标检测
- Highlight:视频浓缩
示例值:Highlight
StartTime Integer 对应云存视频的起始时间
示例值:1710487888
EndTime Integer 对应云存视频的结束时间
示例值:1710487898
Status Integer 任务状态(1:失败;2:成功但结果为空;3:成功且结果非空;4:执行中)
示例值:3
Result String 任务结果
示例值:{"param1":"value1"}
Files Array of String 任务输出文件列表
示例值:["output.mp4"]
CreateTime Integer 创建时间
示例值:1711338476
UpdateTime Integer 最后更新时间
示例值:1711338476
CustomId String 自定义任务 ID
示例值:event-123

CloudStorageEvent

云存事件

被如下接口引用:DescribeCloudStorageEvents。

名称 类型 必选 描述
StartTime Integer 事件起始时间(Unix 时间戳,秒级
示例值:1560355200
EndTime Integer 事件结束时间(Unix 时间戳,秒级
示例值:1601196327
Thumbnail String 事件缩略图
示例值:/100008401725/AQTV2839QJ/sp01_328202375/events/123.jpg
EventId String 事件ID
示例值:low_power
UploadStatus String 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:Finished
Data String 事件自定义数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:name

CloudStorageTimeData

云存时间轴接口返回数据

被如下接口引用:DescribeCloudStorageTime。

名称 类型 必选 描述
TimeList Array of CloudStorageTimeInfo 云存时间轴信息列表
VideoURL String 播放地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https

CloudStorageTimeInfo

云存时间轴信息

被如下接口引用:DescribeCloudStorageTime。

名称 类型 必选 描述
StartTime Integer 开始时间
示例值:1642661618
EndTime Integer 结束时间

CloudStorageUserInfo

云存用户信息

被如下接口引用:DescribeCloudStorageUsers。

名称 类型 描述
UserId String 用户ID
示例值:user

DeviceActiveResult

设备激活结果数据

被如下接口引用:ActivateTWeCallLicense。

名称 类型 描述
ModelId String 模版ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12374tg
Sn String SN信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:product_device
ErrCode Integer 设备激活状态,0:激活成功;9800020:设备数超出限制;9800040:资源包类型和设备类型不匹配;9800039:资源包余额不足;9800037:激活码序号已使用;9800038:设备有效期超出限制;
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ExpireTime Integer 过期时间
注意:此字段可能返回 null,表示取不到有效值。

DeviceData

DeviceData

被如下接口引用:CreateDevice。

名称 类型 描述
DeviceCert String 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数。
注意:此字段可能返回 null,表示取不到有效值。
DeviceName String 设备名称。
注意:此字段可能返回 null,表示取不到有效值。
DevicePrivateKey String 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数。
注意:此字段可能返回 null,表示取不到有效值。
DevicePsk String 对称加密密钥,base64编码。采用对称加密时返回该参数。
注意:此字段可能返回 null,表示取不到有效值。

DeviceDataHistoryItem

设备历史数据结构

被如下接口引用:DescribeDeviceDataHistory。

名称 类型 描述
Time String 时间点,毫秒时间戳
Value String 字段取值

DeviceFirmwareInfo

设备固件信息

被如下接口引用:DescribeDeviceFirmwares。

名称 类型 描述
FwType String 固件类型
示例值:mcu
Version String 固件版本
示例值:1.0
UpdateTime Integer 最后更新时间
示例值:1653893719

DeviceInfo

设备详细信息

被如下接口引用:DescribeDevice, GetDeviceList。

名称 类型 描述
DeviceName String 设备名
示例值:1
Status Integer 0: 离线, 1: 在线, 2: 获取失败, 3 未激活
示例值:2
DevicePsk String 设备密钥,密钥加密的设备返回
示例值:2
FirstOnlineTime Integer 首次上线时间
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
LoginTime Integer 最后一次上线时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
CreateTime Integer 设备创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Version String 设备固件版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DeviceCert String 设备证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
LogLevel Integer 日志级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DevAddr String LoRaWAN 设备地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
AppKey String LoRaWAN 应用密钥
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DevEUI String LoRaWAN 设备唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
AppSKey String LoRaWAN 应用会话密钥
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
NwkSKey String LoRaWAN 网络会话密钥
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
CreateUserId Integer 创建人Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreatorNickName String 创建人昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableState Integer 启用/禁用状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProductId String 产品ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:TOIDHQ3AOQ
ProductName String 产品名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:智能音箱
DeviceType String 设备类型(设备、子设备、网关)
注意:此字段可能返回 null,表示取不到有效值。
示例值:设备
IsLora Boolean 是否是 lora 设备
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

DevicePositionItem

设备位置详情

被如下接口引用:DescribeDevicePositionList。

名称 类型 描述
DeviceName String 设备名称
CreateTime Integer 位置信息时间
Longitude Float 设备经度信息
Latitude Float 设备纬度信息

DeviceSignatureInfo

设备签名

被如下接口引用:GenSingleDeviceSignatureOfPublic。

名称 类型 描述
DeviceName String 设备名
DeviceSignature String 设备签名

DeviceUser

设备的用户

被如下接口引用:GetFamilyDeviceUserList。

名称 类型 描述
UserId String 用户ID
示例值:userId
Role Integer 用户角色 1所有者,0:其他分享者
示例值:0
FamilyId String 家庭ID,所有者带该参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:f_1234567
FamilyName String 家庭名称,所有者带该参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:家庭名称

DevicesItem

ProductId -> DeviceName

被如下接口引用:DeleteDevices, UpdateDevicesEnableState。

名称 类型 必选 描述
ProductId String 产品id
示例值:JZYTG1M2EN
DeviceName String 设备名称
示例值:dev01

EventHistoryItem

设备事件的搜索结果项

被如下接口引用:ListEventHistory。

名称 类型 描述
TimeStamp Integer 事件的时间戳
注意:此字段可能返回 null,表示取不到有效值。
ProductId String 事件的产品ID
注意:此字段可能返回 null,表示取不到有效值。
DeviceName String 事件的设备名称
注意:此字段可能返回 null,表示取不到有效值。
EventId String 事件的标识符ID
注意:此字段可能返回 null,表示取不到有效值。
Type String 事件的类型
注意:此字段可能返回 null,表示取不到有效值。
Data String 事件的数据
注意:此字段可能返回 null,表示取不到有效值。

FamilySubDevice

子设备详情

被如下接口引用:DescribeGatewaySubDeviceList, GetGatewaySubDeviceList。

名称 类型 描述
ProductId String 产品Id
示例值:productId
DeviceName String 设备名称
示例值:devicename
DeviceId String 设备ID
示例值:deviceId
AliasName String 设备别名
注意:此字段可能返回 null,表示取不到有效值。
示例值:aliasName
FamilyId String 设备绑定的家庭ID
示例值:familyId
RoomId String 设备所在的房间ID,默认"0"
注意:此字段可能返回 null,表示取不到有效值。
示例值:roomId
IconUrl String 图标
注意:此字段可能返回 null,表示取不到有效值。
示例值:url
IconUrlGrid String grid图标
注意:此字段可能返回 null,表示取不到有效值。
示例值:url
CreateTime Integer 设备绑定时间戳
示例值:1627459546
UpdateTime Integer 设备更新时间戳
示例值:1627459546

FenceAlarmPoint

围栏告警位置点

被如下接口引用:DescribeFenceEventList, DescribeSpaceFenceEventList。

名称 类型 描述
AlarmTime Integer 围栏告警时间
Longitude Float 围栏告警位置的经度
Latitude Float 围栏告警位置的纬度

FenceBindDeviceItem

围栏绑定的设备信息

被如下接口引用:CreateFenceBind, DeleteFenceBind, DescribeFenceBindList, ModifyFenceBind。

名称 类型 必选 描述
DeviceName String 设备名称
AlertCondition String 告警条件(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警)
FenceEnable Boolean 是否使能围栏(true,使能;false,禁用)
Method String 告警处理方法

FenceBindProductItem

围栏绑定的产品信息

被如下接口引用:CreateFenceBind, DeleteFenceBind, DescribeFenceBindList, ModifyFenceBind。

名称 类型 必选 描述
Devices Array of FenceBindDeviceItem 围栏绑定的设备信息
ProductId String 围栏绑定的产品Id

FenceEventItem

围栏事件详情

被如下接口引用:DescribeFenceEventList, DescribeSpaceFenceEventList。

名称 类型 描述
ProductId String 围栏事件的产品Id
DeviceName String 围栏事件的设备名称
FenceId Integer 围栏Id
AlertType String 围栏事件的告警类型(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警)
Data FenceAlarmPoint 围栏事件的设备位置信息

Filter

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

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。

  • 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。

被如下接口引用:GetDeviceList, SearchStudioProduct。

名称 类型 必选 描述
Name String 需要过滤的字段
示例值:tag:tag-key
Values Array of String 字段的过滤的一个或多个值
示例值:tag-value

FirmwareInfo

设备固件详细信息

被如下接口引用:ListFirmwares。

名称 类型 描述
Version String 固件版本
示例值:1.0.0
Md5sum String 固件MD5值
示例值:bd9dc3549a0d75bb242d9d4f5842f221
CreateTime Integer 固件创建时间
示例值:1619322032
ProductName String 产品名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:productName
Name String 固件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:firmwareName
Description String 固件描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:firmwareDesc
ProductId String 产品ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:productId
FwType String 固件升级模块
注意:此字段可能返回 null,表示取不到有效值。
示例值:mcu
CreateUserId Integer 创建者子 uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
CreatorNickName String 创建者昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:喵喵
UserDefined String 固件用户自定义配置信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"key1":"value1", "key2":"支持中文"}

InstanceDetail

实例信息
公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效

被如下接口引用:DescribeInstance。

名称 类型 描述
InstanceId String 实例ID
示例值:test
InstanceType Integer 实例类型(0 公共实例 1 标准企业实例 2新企业实例3新公共实例)
示例值:1
Region String 地域字母缩写
示例值:test
ZoneId String 区域全拼
示例值:test
TotalDeviceNum Integer 支持设备总数
示例值:1
UsedDeviceNum Integer 已注册设备数
示例值:1
ProjectNum Integer 项目数
示例值:1
ProductNum Integer 产品数
示例值:1
CreateTime Timestamp ISO8601 创建时间
示例值:1234243
UpdateTime Timestamp ISO8601 更新时间
示例值:234132432
ExpireTime Timestamp ISO8601 过期时间,公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效
示例值:23142134123
TotalDevice Integer 总设备数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ActivateDevice Integer 激活设备数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:备注
Status Integer 实例状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpDownTPS Integer 消息上下行配置TPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpDownCurrentTPS Integer 当前消息上下行TPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ForwardTPS Integer 消息转发配置TPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ForwardCurrentTPS Integer 消息转发当前TPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CellNum Integer 实例单元数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BillingTag String 实例Tag
注意:此字段可能返回 null,表示取不到有效值。
EverydayFreeMessageCount Integer 每日消息数
注意:此字段可能返回 null,表示取不到有效值。
MaxDeviceOnlineCount Integer 最大在线设备数
注意:此字段可能返回 null,表示取不到有效值。

LoRaFrequencyEntry

LoRa自定义频点信息

被如下接口引用:CreateLoRaFrequency, DescribeLoRaFrequency, ModifyLoRaFrequency。

名称 类型 描述
FreqId String 频点唯一ID
FreqName String 频点名称
Description String 频点描述
ChannelsDataUp Array of Integer 数据上行信道
ChannelsDataRX1 Array of Integer 数据下行信道RX1
ChannelsDataRX2 Array of Integer 数据下行信道RX2
ChannelsJoinUp Array of Integer 入网上行信道
ChannelsJoinRX1 Array of Integer 入网下行RX1信道
ChannelsJoinRX2 Array of Integer 入网下行RX2信道
CreateTime Integer 创建时间

LoRaGatewayItem

LoRa 网关信息

被如下接口引用:CreateLoRaGateway, GetLoRaGatewayList, ModifyLoRaGateway。

名称 类型 必选 描述
GatewayId String LoRa 网关Id
IsPublic Boolean 是否是公开网关
Description String 网关描述
Name String 网关名称
Position String 网关位置信息
PositionDetails String 网关位置详情
Location LoRaGatewayLocation LoRa 网关位置坐标
UpdatedAt String 最后更新时间
CreatedAt String 创建时间
LastSeenAt String 最后上报时间
FrequencyId String 频点ID

LoRaGatewayLocation

网关坐标

被如下接口引用:CreateLoRaGateway, GetLoRaGatewayList, ModifyLoRaGateway。

名称 类型 必选 描述
Latitude Float 纬度
示例值:0.0
Longitude Float 精度
示例值:0.0
Accuracy Float 准确度
示例值:0.0
Altitude Float 海拔
示例值:0.0

PackageConsumeStat

云存套餐包消耗统计

被如下接口引用:DescribeCloudStoragePackageConsumeStats。

名称 类型 描述
PackageId String 云存套餐包id
示例值:yc1m3d
PackageName String 云存套餐包名称
示例值:全时3天月卡
Cnt Integer 消耗个数
示例值:10
Price Integer 套餐包单价,单位分
示例值:595
Source Integer 消耗来源,1预付费
示例值:1

PackageConsumeTask

套餐包消耗任务列表

被如下接口引用:DescribePackageConsumeTasks。

名称 类型 描述
TaskId Integer 任务id
示例值:121
CreateTime String 任务创始时间
示例值:2021-11-02 11:11:12
State Integer 任务状态,1待处理,2处理中,3已完成
示例值:1

PackageInfo

结构体(PackageInfo)记录了设备拥有的有效套餐信息,包括云存开启状态、云存类型、云存回看时长、云存套餐过期时间

被如下接口引用:DescribeDevicePackages。

名称 类型 描述
Status Integer 云存开启状态,0为未开启,2为正在生效,1为已过期
注:这里只返回状态为0的数据
示例值:0
CSType Integer 云存类型,1为全时云存,2为事件云存
示例值:1
CSShiftDuration Integer 云存回看时长
示例值:259200
CSExpiredTime Integer 云存套餐过期时间
示例值:1697870539
CreatedAt Integer 云存套餐创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1690254147
UpdatedAt Integer 云存套餐更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1690254147
PackageId String 套餐id
注意:此字段可能返回 null,表示取不到有效值。
示例值:"sdfds"
OrderId String 订单id
注意:此字段可能返回 null,表示取不到有效值。
示例值:"sdfsdf"
ChannelId Integer 通道id
示例值:0
CSUserId String 用户id
注意:此字段可能返回 null,表示取不到有效值。
示例值:gjhghjk

PositionFenceInfo

围栏详细信息(包含创建时间及更新时间)

被如下接口引用:DescribePositionFenceList。

名称 类型 描述
GeoFence PositionFenceItem 围栏信息
CreateTime Integer 围栏创建时间
UpdateTime Integer 围栏更新时间

PositionFenceItem

围栏信息

被如下接口引用:DescribePositionFenceList。

名称 类型 描述
FenceId Integer 围栏Id
SpaceId String 位置空间Id
FenceName String 围栏名称
FenceDesc String 围栏描述
FenceArea String 围栏区域信息,采用 GeoJSON 格式

PositionItem

位置点

被如下接口引用:GetDeviceLocationHistory。

名称 类型 描述
CreateTime Integer 位置点的时间
示例值:1597042572000
Longitude Float 位置点的经度
示例值:106.04509595706622
Latitude Float 位置点的纬度
示例值:27.030664678580806
LocationType String 位置点的定位类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:NAV
Accuracy Float 位置点的精度预估,单位为米
注意:此字段可能返回 null,表示取不到有效值。
示例值:42.3

PositionSpaceInfo

位置空间详情

被如下接口引用:GetPositionSpaceList, SearchPositionSpace。

名称 类型 描述
ProjectId String 项目Id
示例值:prj
SpaceId String 位置空间Id
示例值:a877xxxa1
SpaceName String 位置空间名称
示例值:name
AuthorizeType Integer 授权类型
示例值:0
Description String 描述备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:desc
ProductIdList Array of String 产品列表
示例值:["TOIDHQ3AO1","TOIDHQ3AO2"]]
Icon String 缩略图
示例值:icon
CreateTime Integer 创建时间
示例值:1598863974
UpdateTime Integer 更新时间
示例值:1598863974
Zoom Integer 用户自定义地图缩放
示例值:3

ProductDevicesPositionItem

产品设备位置信息

被如下接口引用:DescribeDevicePositionList。

名称 类型 描述
Items Array of DevicePositionItem 设备位置列表
ProductId String 产品标识
Total Integer 设备位置数量

ProductEntry

产品详情

被如下接口引用:CreateStudioProduct, DescribeStudioProduct, GetStudioProductList, ModifyStudioProduct, SearchStudioProduct。

名称 类型 描述
ProductId String 产品ID
示例值:1
ProductName String 产品名称
示例值:1
CategoryId Integer 产品分组模板ID
示例值:0
EncryptionType String 加密类型。1表示证书认证,2表示秘钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式
示例值:0
NetType String 连接类型。如:
wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh
示例值:0
DataProtocol Integer 数据协议 (1 使用物模型 2 为自定义类型)
示例值:0
ProductDesc String 产品描述
示例值:0
DevStatus String 状态 如:all 全部, dev 开发中, audit 审核中 released 已发布
示例值:0
CreateTime Integer 创建时间
示例值:0
UpdateTime Integer 更新时间
示例值:0
Region String 区域
示例值:0
ProductType Integer 产品类型。如: 0 普通产品 , 5 网关产品
示例值:0
ProjectId String 项目ID
示例值:0
ModuleId Integer 产品ModuleId
示例值:0
EnableProductScript String 是否使用脚本进行二进制转json功能 可以取值 true / false
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateUserId Integer 创建人 UinId
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreatorNickName String 创建者昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BindStrategy Integer 绑定策略(1:强踢;2:非强踢;0:表示无意义)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeviceCount Integer 设备数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Rate String 平均传输速率
注意:此字段可能返回 null,表示取不到有效值。
示例值:1_0_mbps
Period String 有效期
注意:此字段可能返回 null,表示取不到有效值。
示例值:5_year

ProductModelDefinition

产品模型定义

被如下接口引用:DescribeModelDefinition。

名称 类型 描述
ProductId String 产品ID
ModelDefine String 模型定义
UpdateTime Integer 更新时间,秒级时间戳
CreateTime Integer 创建时间,秒级时间戳
CategoryModel String 产品所属分类的模型快照(产品创建时刻的)
注意:此字段可能返回 null,表示取不到有效值。
NetTypeModel String 产品的连接类型的模型
注意:此字段可能返回 null,表示取不到有效值。

ProjectEntry

项目详情

被如下接口引用:CreateProject, ModifyProject。

名称 类型 描述
ProjectId String 项目ID
ProjectName String 项目名称
ProjectDesc String 项目描述
CreateTime Integer 创建时间,unix时间戳
UpdateTime Integer 更新时间,unix时间戳

ProjectEntryEx

项目详情

被如下接口引用:DescribeProject, GetProjectList。

名称 类型 描述
ProjectId String 项目ID
示例值:“”
ProjectName String 项目名称
示例值:“”
ProjectDesc String 项目描述
示例值:“”
CreateTime Integer 项目创建时间,unix时间戳
示例值:0
UpdateTime Integer 项目更新时间,unix时间戳
示例值:0
ProductCount Integer 产品数量
示例值:0
NativeAppCount Integer NativeApp数量
示例值:0
WebAppCount Integer WebApp数量
示例值:0
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:“”
ApplicationCount Integer 应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DeviceCount Integer 设备注册总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EnableOpenState Integer 是否开通物联使能
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

SearchKeyword

搜索关键词

被如下接口引用:ListFirmwares。

名称 类型 必选 描述
Key String 搜索条件的Key
Value String 搜索条件的值

TRTCParams

TRTC 的参数 可以用来加入房间

被如下接口引用:CreateTRTCSignaturesWithRoomId。

名称 类型 描述
SdkAppId Integer TRTC入参: TRTC的实例ID
UserId String TRTC入参: 用户加入房间的ID
UserSig String TRTC入参: 用户的签名用来鉴权
StrRoomId String TRTC入参: 加入的TRTC房间名称
PrivateKey String TRTC入参: 校验TRTC的KEY

TWeCallActiveInfo

TWeCall设备激活信息

被如下接口引用:GetTWeCallActiveStatus。

名称 类型 描述
ModelId String 小程序ID
注意:此字段可能返回 null,表示取不到有效值。
Sn String Sn信息
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Integer 过期时间
注意:此字段可能返回 null,表示取不到有效值。

TWeCallCategoryPkgInfo

TWeCall分类统计数据

被如下接口引用:GetTWeCallPkgList。

名称 类型 必选 描述
PkgType Integer 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
All Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Used Integer 已使用数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

TWeCallInfo

TWeCall信息

被如下接口引用:ActivateTWeCallLicense, GetTWeCallActiveStatus。

名称 类型 必选 描述
ModelId String 小程序ID
注意:此字段可能返回 null,表示取不到有效值。
Sn String Sn信息,SN格式:产品ID_设备名
注意:此字段可能返回 null,表示取不到有效值。
ActiveNum Integer 激活数
注意:此字段可能返回 null,表示取不到有效值。

TWeCallPkgInfo

TWeCall设备信息

被如下接口引用:GetTWeCallPkgList。

名称 类型 必选 描述
PkgId String 包ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:3edc
PkgType Integer 包类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime Integer 生效时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:198653423
ExpireTime Integer 过期时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:198653423
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LicenseUsedNum Integer 已使用
注意:此字段可能返回 null,表示取不到有效值。
LicenseTotalNum Integer 总量
注意:此字段可能返回 null,表示取不到有效值。

ThumbnailURLInfoList

缩略图信息

被如下接口引用:DescribeCloudStorageMultiThumbnail, DescribeCloudStorageThumbnailList。

名称 类型 必选 描述
ThumbnailURL String 缩略图访问地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://video-cv-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100
ExpireTime Integer 缩略图访问地址的过期时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1690195335

TopicItem

Topic信息, 包括Topic名字和权限

被如下接口引用:ListTopicPolicy。

名称 类型 描述
TopicName String Topic名称
Privilege Integer Topic权限 , 1上报 2下发

TopicRule

TopicRule结构

被如下接口引用:DescribeTopicRule。

名称 类型 描述
RuleName String 规则名称。
Sql String 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
Description String 规则描述。
注意:此字段可能返回 null,表示取不到有效值。
Actions String 行为的JSON字符串。
注意:此字段可能返回 null,表示取不到有效值。
RuleDisabled Boolean 是否禁用规则
注意:此字段可能返回 null,表示取不到有效值。

TopicRuleInfo

规则信息

被如下接口引用:GetTopicRuleList, SearchTopicRule。

名称 类型 描述
RuleName String 规则名称
Description String 规则描述
CreatedAt Integer 创建时间
RuleDisabled Boolean 规则是否禁用

TopicRulePayload

TopicRulePayload结构

被如下接口引用:CreateTopicRule, ModifyTopicRule。

名称 类型 必选 描述
Sql String 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
Actions String 行为的JSON字符串,大部分种类举例如下:
[
{
"republish": {
"topic": "TEST/test"
}
},
{
"forward": {
"api": "http://test.com: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 是否禁用规则

WXDeviceInfo

微信硬件设备信息

被如下接口引用:GetWechatDeviceTicket。

名称 类型 描述
DeviceId String 设备ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:p/d
WXIoTDeviceInfo WXIoTDeviceInfo 设备信息
注意:此字段可能返回 null,表示取不到有效值。

WXIoTDeviceInfo

微信物联网硬件信息

被如下接口引用:GetWechatDeviceTicket。

名称 类型 必选 描述
SN String sn信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1234567
SNTicket String 票据
注意:此字段可能返回 null,表示取不到有效值。
示例值:4rf5gtg
ModelId String 模版ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:3rfv

WifiInfo

wifi定位信息

被如下接口引用:DescribeDeviceLocationSolve。

名称 类型 必选 描述
MAC String mac地址
示例值:78a106a5b166
RSSI Integer 信号强度
示例值:-1