物联网智能视频服务（消费版）

文档中心物联网智能视频服务（消费版） API 文档物联网智能视频服务 API 2020-12-15 数据结构

数据结构

最近更新时间：2023-08-17 03:37:05

我的收藏

本页目录：

AIModelApplication

AI模型申请信息

被如下接口引用：DescribeAIModelApplications。

名称	类型	必选	描述
ProductId	String	是	产品ID 示例值：WYILLHRQ4
ProductName	String	是	产品名称示例值：test
Status	Integer	是	申请状态：1-已申请；2-已取消；3-已拒绝；4-已通过示例值：1

AIModelInfo

AI模型信息

被如下接口引用：DescribeAIModels。

名称	类型	必选	描述
ProductId	String	是	产品ID 示例值：WYILLHRQ4
ProductName	String	是	产品名称示例值：test
Status	Integer	是	申请状态：1-已申请；2-已取消；3-已拒绝；4-已通过示例值：1
Total	Integer	是	可调用数量示例值：10000
Used	Integer	是	已调用数量示例值：9845
ApplyTime	Integer	是	申请时间示例值：1620289238
ApprovalTime	Integer	是	审批通过时间示例值：1620289238

AIModelUsageInfo

AI模型资源使用信息

被如下接口引用：DescribeAIModelUsage。

名称	类型	必选	描述
CreateTime	Integer	是	开通时间示例值：1620289238
Total	Integer	是	资源总量示例值：10000
Used	Integer	是	已使用资源数量示例值：982

ActionHistory

查询设备历史

被如下接口引用：DescribeDeviceActionHistory。

名称	类型	描述
DeviceName	String	设备名称
ActionId	String	动作Id
ActionName	String	动作名称
ReqTime	Integer	请求时间
RspTime	Integer	响应时间
InputParams	String	输入参数注意：此字段可能返回 null，表示取不到有效值。
OutputParams	String	输出参数注意：此字段可能返回 null，表示取不到有效值。
Calling	String	调用方式
ClientToken	String	调用Id
Status	String	调用状态

BalanceTransaction

账户流水

被如下接口引用：DescribeBalanceTransactions。

名称	类型	必选	描述
AccountType	Integer	是	账户类型：1-设备接入 2-云存。示例值：1
Operation	String	是	账户变更类型：Rechareg-充值；CreateOrder-新购。示例值：Recharge
DealId	String	是	流水ID。示例值：a561b35c-6897-4d70-a033-141e13a7b573
Amount	Integer	是	变更金额，单位：分（人民币）。示例值：200
Balance	Integer	是	变更后账户余额，单位：分（人民币）。示例值：4200
OperationTime	Integer	是	变更时间。示例值：1621230175

CloudStorageEvent

云存事件

被如下接口引用：DescribeCloudStorageEvents。

名称	类型	必选	描述
StartTime	Integer	是	事件起始时间（Unix 时间戳，秒级示例值：1560355200
EndTime	Integer	是	事件结束时间（Unix 时间戳，秒级示例值：1601196327
Thumbnail	String	是	事件缩略图示例值：/100008401725/AQTV2839QJ/sp01_328202375/events/123.jpg
EventId	String	是	事件ID 示例值：low_power

CloudStorageTimeData

云存时间轴接口返回数据

被如下接口引用：DescribeCloudStorageTime。

名称	类型	描述
TimeList	Array of CloudStorageTimeInfo	云存时间轴信息列表
VideoURL	String	播放地址

CloudStorageTimeInfo

云存时间轴信息

被如下接口引用：DescribeCloudStorageTime。

名称	类型	描述
StartTime	Integer	开始时间
EndTime	Integer	结束时间

CloudStorageUserInfo

云存用户信息

被如下接口引用：DescribeCloudStorageUsers。

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

DataForward

数据转发描述

被如下接口引用：DescribeDataForwardList。

名称	类型	描述
ProductId	String	产品ID。示例值：TOIDHQ3AOQ
ForwardAddr	String	转发地址。示例值：[{"forward":{"api":"http://123.207.117.108:1080/sub.php\"}}
Status	Integer	转发状态。示例值：0
CreateTime	Integer	创建时间。示例值：1619490248
UpdateTime	Integer	更新时间。示例值：1619490248
DataChose	Integer	1-数据信息转发 2-设备上下线状态转发 3-数据信息转发&设备上下线状态转发注意：此字段可能返回 null，表示取不到有效值。示例值：1

DeviceCommLogItem

设备通讯日志查询返回条目

被如下接口引用：DescribeDeviceCommLog。

名称	类型	描述
Time	String	时间
Type	String	日志类型，device 设备上行，shadow 服务端下行。
Data	String	通讯数据。

DeviceDataHistoryItem

设备历史数据结构

被如下接口引用：DescribeDeviceDataHistory。

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

DeviceInfo

设备详细信息

被如下接口引用：DescribeDevices。

名称	类型	描述
DeviceName	String	设备名示例值：video_00001
Online	Integer	设备是否在线，0不在线，1在线，2获取失败，3未激活示例值：0
LoginTime	Integer	设备最后上线时间示例值：1625543955
DevicePsk	String	设备密钥示例值：Cdakt7OGTs8689DT1qv0w==
EnableState	Integer	设备启用状态 0为停用 1为可用示例值：1
ExpireTime	Integer	设备过期时间示例值：1657024030
LogLevel	Integer	设备的sdk日志等级，0：关闭，1：错误，2：告警，3：信息，4：调试注意：此字段可能返回 null，表示取不到有效值。示例值：1

DeviceStatusLogItem

设备上下线日志记录

被如下接口引用：DescribeDeviceStatusLog。

名称	类型	描述
Time	String	时间示例值：2020-03-07 00:00:00
Type	String	状态类型： Online 上线，Offline 下线示例值：Online
Data	String	日志信息

DeviceUpdateStatus

设备固件更新状态

被如下接口引用：DescribeFirmwareTaskDevices。

名称	类型	描述
DeviceName	String	设备名示例值：test
LastProcessTime	Integer	最后处理时间示例值：12356
Status	Integer	状态示例值：1
ErrMsg	String	错误消息示例值：test
Retcode	Integer	返回码示例值：1
DstVersion	String	目标更新版本示例值：1-2-2
Percent	Integer	下载中状态时的下载进度注意：此字段可能返回 null，表示取不到有效值。示例值：50
OriVersion	String	原版本号注意：此字段可能返回 null，表示取不到有效值。示例值：1-2-1
TaskId	Integer	任务ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1231412

EventHistoryItem

设备事件的搜索结果项

被如下接口引用：DescribeDeviceEventHistory。

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

FirmwareInfo

设备固件详细信息

被如下接口引用：ListFirmwares。

名称	类型	描述
Version	String	固件版本示例值：1-2-1
Md5sum	String	固件MD5值示例值：abcde
CreateTime	Integer	固件创建时间示例值：1234567
ProductName	String	产品名称示例值：test
Name	String	固件名称示例值：testota
Description	String	固件描述示例值：aaaaa
ProductId	String	产品ID 示例值：A1BC

FirmwareTaskInfo

固件升级任务信息

被如下接口引用：DescribeFirmwareTasks。

名称	类型	描述
TaskId	Integer	任务ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1234
Status	Integer	任务状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
Type	Integer	任务类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreateTime	Integer	任务创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：1231456

ProductModelDefinition

产品模型定义

被如下接口引用：DescribeModelDefinition。

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

ProductTemplate

产品分类实体

被如下接口引用：DescribeCategory。

名称	类型	描述
Id	Integer	实体ID
CategoryKey	String	分类字段
CategoryName	String	分类名称
ParentId	Integer	上层实体ID
ModelTemplate	String	物模型
ListOrder	Integer	排列顺序注意：此字段可能返回 null，表示取不到有效值。
IconUrl	String	分类图标地址注意：此字段可能返回 null，表示取不到有效值。
IconUrlGrid	String	九宫格图片地址注意：此字段可能返回 null，表示取不到有效值。

SDKLogItem

SDK日志项

被如下接口引用：DescribeSDKLog。

名称	类型	描述
ProductID	String	产品ID 示例值：WYILLHRQ4
DeviceName	String	设备名称示例值：dev
Level	String	日志等级示例值：1
DateTime	String	日志时间示例值：2020-03-07 00:00:00
Content	String	日志内容

SearchKeyword

搜索关键词

被如下接口引用：DescribeFirmwareTaskDevices, DescribeFirmwareTasks, ListFirmwares。

名称	类型	必选	描述
Key	String	是	搜索条件的Key 示例值：a
Value	String	否	搜索条件的值示例值：b

StatusStatistic

状态统计信息

被如下接口引用：DescribeFirmwareTaskDistribution。

名称	类型	描述
Status	Integer	任务状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
Total	Integer	统计总数注意：此字段可能返回 null，表示取不到有效值。示例值：123

VideoBatch

批次元数据

被如下接口引用：DescribeBatch, DescribeBatchs。

名称	类型	描述
Id	Integer	批次ID
UserId	String	用户ID
ProductId	String	产品ID
Status	Integer	状态：1：待创建设备 2：创建中 3：已完成
DevPre	String	设备前缀
DevNum	Integer	设备数量
DevNumCreated	Integer	已创建设备数量
BatchURL	String	批次下载地址
CreateTime	Integer	创建时间。unix时间戳
UpdateTime	Integer	修改时间。unix时间戳

VideoProduct

video产品元数据

被如下接口引用：CreateProduct, DescribeProduct, DescribeProducts。

名称	类型	描述
ProductId	String	产品ID 示例值：PV1674YINM
ProductName	String	产品名称示例值：test
DeviceType	Integer	产品设备类型（普通设备) 1.普通设备示例值：1
EncryptionType	Integer	认证方式：2：PSK 示例值：2
Features	Array of String	设备功能码示例值：ypsxth,spdxth
ChipOs	String	操作系统示例值：default
ChipManufactureId	String	芯片厂商id 示例值：default
ChipId	String	芯片id 示例值：default
ProductDescription	String	产品描述信息示例值：test
CreateTime	Integer	创建时间unix时间戳示例值：1638340550
UpdateTime	Integer	修改时间unix时间戳示例值：1638340550
NetType	String	连接类型，wifi表示WIFI连接，cellular表示4G连接注意：此字段可能返回 null，表示取不到有效值。示例值：wifi