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

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

数据结构

最近更新时间：2024-02-22 01:17:56

我的收藏

本页目录：

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	设备名称示例值：device
ActionId	String	动作Id 示例值：body_detection
ActionName	String	动作名称示例值：body_detection
ReqTime	Integer	请求时间示例值：1642661618
RspTime	Integer	响应时间示例值：1642661618
InputParams	String	输入参数注意：此字段可能返回 null，表示取不到有效值。示例值：{}
OutputParams	String	输出参数注意：此字段可能返回 null，表示取不到有效值。示例值：{}
Calling	String	调用方式示例值：sync
ClientToken	String	调用Id 示例值：192002627:180649
Status	String	调用状态示例值：ok

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

BonusInfo

运营活动资源包信息

被如下接口引用：DescribeBonuses。

名称	类型	描述
BonusId	Integer	资源包ID 示例值：1001
UserId	String	用户ID 示例值：90968674
PackageId	String	资源包配置ID 示例值：device-bonus-1y10w
Total	Integer	资源总数示例值：100000
Used	Integer	资源消耗总数示例值：200
ExpireTime	Integer	资源包过期时间示例值：1634698286
CreateTime	Integer	资源包创建时间示例值：1634695286
Status	Integer	资源包状态 0.未使用 1.使用中 2.已退款 3.已过期注意：此字段可能返回 null，表示取不到有效值。示例值：0

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	播放地址示例值：https

CloudStorageTimeInfo

云存时间轴信息

被如下接口引用：DescribeCloudStorageTime。

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

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

DeviceCntStats

设备数量统计

被如下接口引用：DescribeDeviceDataStats。

名称	类型	描述
Date	String	统计日期示例值：2022-06-12
NewRegisterCnt	Integer	新增注册设备数注意：此字段可能返回 null，表示取不到有效值。示例值：11
NewActivateCnt	Integer	新增激活设备数注意：此字段可能返回 null，表示取不到有效值。示例值：2
ActiveCnt	Integer	活跃设备数注意：此字段可能返回 null，表示取不到有效值。示例值：3

DeviceCommLogItem

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

被如下接口引用：DescribeDeviceCommLog。

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

DeviceDataHistoryItem

设备历史数据结构

被如下接口引用：DescribeDeviceDataHistory。

名称	类型	描述
Time	String	时间点，毫秒时间戳示例值：1642661618
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

DeviceSignatureInfo

设备签名信息

被如下接口引用：GenSingleDeviceSignatureOfPublic。

名称	类型	描述
DeviceName	String	设备名称示例值：dev001
DeviceSignature	String	设备签名示例值：fbaba57679644f29adee48652864xxxx

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，表示取不到有效值。示例值：1642661618
ProductId	String	事件的产品ID 注意：此字段可能返回 null，表示取不到有效值。示例值：PV1674YINM
DeviceName	String	事件的设备名称注意：此字段可能返回 null，表示取不到有效值。示例值：device
EventId	String	事件的标识符ID 注意：此字段可能返回 null，表示取不到有效值。示例值：body_detection
Type	String	事件的类型注意：此字段可能返回 null，表示取不到有效值。示例值：alarm
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
FwType	String	固件升级模块注意：此字段可能返回 null，表示取不到有效值。示例值：mcu

FirmwareTaskInfo

固件升级任务信息

被如下接口引用：DescribeFirmwareTasks。

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

MessageCntStats

消息数量统计

被如下接口引用：DescribeMessageDataStats。

名称	类型	描述
Date	String	统计日期示例值：2022-06-12
UpMsgCnt	Integer	物模型上行消息数注意：此字段可能返回 null，表示取不到有效值。示例值：123
DownMsgCnt	Integer	物模型下行消息数注意：此字段可能返回 null，表示取不到有效值。示例值：123
NtpMsgCnt	Integer	ntp消息数注意：此字段可能返回 null，表示取不到有效值。示例值：123

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

ProductModelDefinition

产品模型定义

被如下接口引用：DescribeModelDefinition。

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

ProductTemplate

产品分类实体

被如下接口引用：DescribeCategory。

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

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

TRTCParams

TRTC调用参数

被如下接口引用：CallTRTCDevice。

名称	类型	描述
SDKAppId	Integer	应用id，供TRTC SDK使用注意：此字段可能返回 null，表示取不到有效值。示例值：1234
UserId	String	用户id，供TRTC SDK使用注意：此字段可能返回 null，表示取不到有效值。示例值：userid
UserSig	String	用户id签名，供TRTC SDK使用注意：此字段可能返回 null，表示取不到有效值。示例值：876afmnihawf
StrRoomId	String	房间id，供TRTC SDK使用注意：此字段可能返回 null，表示取不到有效值。示例值：rootId
PrivateMapKey	String	权限票据，供TRTC SDK使用注意：此字段可能返回 null，表示取不到有效值。示例值：fjhgugi123

ThumbnailURLInfoList

缩略图信息

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

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

VideoBatch

批次元数据

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

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

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
CategoryId	Integer	产品品类,113:摄像头,567:儿童手表,595:可视对讲门锁注意：此字段可能返回 null，表示取不到有效值。示例值：113
ProductVaildYears	Integer	产品有效年限注意：此字段可能返回 null，表示取不到有效值。示例值：5