BindDevInfo
终端用户绑定的设备
被如下接口引用:DescribeBindDev。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID |
DeviceName | String | 设备名称 |
DeviceModel | String | 设备型号 注意:此字段可能返回 null,表示取不到有效值。 |
Role | String | 用户角色,owner:主人,guest:访客 |
BindUsrInfo
设备绑定的终端用户
被如下接口引用:DescribeBindUsr。
名称 | 类型 | 描述 |
---|---|---|
AccessId | String | IotVideo平台分配给终端用户的用户id |
Role | String | 用户角色,owner:主人,guest:访客 |
CertificateInfo
证书信息
被如下接口引用:CreateUploadTest, RenewUploadTest。
名称 | 类型 | 描述 |
---|---|---|
SecretId | String | SecretId 注意:此字段可能返回 null,表示取不到有效值。 |
SecretKey | String | SecretKey 注意:此字段可能返回 null,表示取不到有效值。 |
Token | String | Token 注意:此字段可能返回 null,表示取不到有效值。 |
ExpiredTime | Integer | 过期时间,UNIX时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
Contents
版本发布的描述信息,需要国际化,可以为空
被如下接口引用:DescribeOtaVersions, ModifyVerContent, RunOtaVersion, UploadOtaVersion。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
En | String | 否 | 英文,长度不超过300个字符 注意:此字段可能返回 null,表示取不到有效值。 |
Cn | String | 否 | 中文简体,长度不超过300个字符 注意:此字段可能返回 null,表示取不到有效值。 |
Tc | String | 否 | 中文繁体(Traditional Chinese),长度不超过300个字符 注意:此字段可能返回 null,表示取不到有效值。 |
Default | String | 否 | 默认语言,最多不超过300个字符 注意:此字段可能返回 null,表示取不到有效值。 |
CosCertificate
申请上传证书回包
被如下接口引用:CreateUploadTest。
名称 | 类型 | 描述 |
---|---|---|
StorageBucket | String | cos存储桶 注意:此字段可能返回 null,表示取不到有效值。 |
StorageRegion | String | cos存储园区 注意:此字段可能返回 null,表示取不到有效值。 |
StoragePath | String | 存储路径,录制场景下该值为存储目录 注意:此字段可能返回 null,表示取不到有效值。 |
TempCertificate | CertificateInfo | 证书信息 注意:此字段可能返回 null,表示取不到有效值。 |
SessionKey | String | SessionKey 注意:此字段可能返回 null,表示取不到有效值。 |
Data
接口DescribeStream输出参数
被如下接口引用:DescribeStream。
名称 | 类型 | 描述 |
---|---|---|
Protocol | String | 直播协议 注意:此字段可能返回 null,表示取不到有效值。 示例值:RTSP |
URI | String | 流媒体播放地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxxxxxxxxxxxxx |
ExpireTime | Integer | 流媒体地址过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1602589211 |
VideoCodec | String | 视频编码 注意:此字段可能返回 null,表示取不到有效值。 示例值:H265 |
AudioCodec | String | 音频编码 注意:此字段可能返回 null,表示取不到有效值。 示例值:G711 |
DevTokenInfo
用于终端用户临时访问设备的token授权信息
被如下接口引用:CreateDevToken。
名称 | 类型 | 描述 |
---|---|---|
AccessId | String | 客户的终端用户在IotVideo上的唯一标识id |
Tid | String | 设备TID |
AccessToken | String | IotVideo平台的accessToken |
ExpireTime | Integer | Token的过期时间,单位秒(UTC时间) |
DeviceCertificate
设备证书及密钥
被如下接口引用:CreateDevices。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID |
Certificate | String | 设备初始证书信息,base64编码 |
WhiteBoxSoUrl | String | 设备私钥下载地址 |
DeviceData
设备信息
被如下接口引用:DescribeDevice。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID 注意:此字段可能返回 null,表示取不到有效值。 |
ActiveTime | Integer | 激活时间 0代表未激活 注意:此字段可能返回 null,表示取不到有效值。 |
Disabled | Boolean | 设备是否被禁用 注意:此字段可能返回 null,表示取不到有效值。 |
OtaVersion | String | 固件版本 注意:此字段可能返回 null,表示取不到有效值。 |
Online | Integer | 设备在线状态 注意:此字段可能返回 null,表示取不到有效值。 |
LastOnlineTime | Integer | 设备最后上线时间(mqtt连接成功时间),UNIX时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
IotModel | String | 物模型json数据 注意:此字段可能返回 null,表示取不到有效值。 |
DeviceName | String | 设备名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProductId | String | 产品ID 注意:此字段可能返回 null,表示取不到有效值。 |
Certificate | String | 设备初始证书信息,base64编码 注意:此字段可能返回 null,表示取不到有效值。 |
WhiteBoxSoUrl | String | 设备私钥下载地址 注意:此字段可能返回 null,表示取不到有效值。 |
StreamStatus | Boolean | 设备推流状态 注意:此字段可能返回 null,表示取不到有效值。 |
DeviceModelData
设备物模型数据
被如下接口引用:DescribeDeviceModel。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID |
Branch | String | 物模型分支路径 注意:此字段可能返回 null,表示取不到有效值。 |
IotModel | String | 物模型数据 注意:此字段可能返回 null,表示取不到有效值。 |
DevicesData
设备列表元素所包含的设备基本信息
被如下接口引用:DescribeDevices。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID |
DeviceName | String | 设备名称 |
ActiveTime | Integer | 激活时间 0代表未激活 |
Disabled | Boolean | 设备是否被禁用 |
StreamStatus | Boolean | 设备推流状态 |
OtaVersion | String | 固件版本 |
Online | Integer | 设备在线状态 |
LastOnlineTime | Integer | 设备最后上线时间(mqtt连接成功时间),UNIX时间戳,单位秒 |
IotModel | String | 物模型json数据 |
LastUpdateTime | Integer | 设备固件最新更新时间,UNIX时间戳,单位秒 |
IotModelData
物模型历史版本
被如下接口引用:DescribeIotModels。
名称 | 类型 | 描述 |
---|---|---|
Revision | Integer | 版本号 |
ReleaseTime | Integer | 发布时间 |
LogData
设备日志信息
被如下接口引用:DescribeLogs。
名称 | 类型 | 描述 |
---|---|---|
Occurtime | Integer | 发生时间 UNIX时间戳,单位秒 |
LogType | Integer | 日志类型 1在线状态变更 2FP变更 3SP变更 4CO控制 5ST变更 6EV事件 |
DataObject | String | 物模型对象索引 注意:此字段可能返回 null,表示取不到有效值。 |
OldValue | String | 物模型旧值 json串 注意:此字段可能返回 null,表示取不到有效值。 |
NewValue | String | 物模型新值 json串 注意:此字段可能返回 null,表示取不到有效值。 |
MsgQueueData
产品转发消息队列配置
被如下接口引用:DescribeMessageQueue。
名称 | 类型 | 描述 |
---|---|---|
MsgQueueType | Integer | 消息队列类型 1:CMQ 2:kafka |
MsgType | String | 消息类型列表,整型值(0-31)之间以“,”分隔 |
Topic | String | 主题名称 |
Instance | String | 实例名称 |
MsgRegion | String | 消息地域 |
OsData
操作系统信息
被如下接口引用:DescribeOsList。
名称 | 类型 | 描述 |
---|---|---|
ChipId | String | 芯片型号 注意:此字段可能返回 null,表示取不到有效值。 |
ChipManufacture | String | 芯片厂商 注意:此字段可能返回 null,表示取不到有效值。 |
OtaPubHistory
产品发布过的全部版本
被如下接口引用:DescribePubVersions。
名称 | 类型 | 描述 |
---|---|---|
OtaVersion | String | 版本名称 |
PublishTime | Integer | 发布时间,unix时间戳,单位:秒 |
ProductBase
产品信息摘要
被如下接口引用:CreateProduct。
名称 | 类型 | 描述 |
---|---|---|
ProductId | String | 产品ID |
ProductModel | String | 产器型号(APP产品,为APP包名) |
ProductName | String | 产品名称 |
ProductDescription | String | 产品描述信息 |
CreateTime | Integer | 创建时间,UNIX 时间戳,单位秒 |
IotModelRevision | Integer | 物模型发布版本号,0代表物模型尚未发布 |
SecretKey | String | 产品密钥 |
FuncCode | Array of String | 设备功能码 ypsxth : 音频双向通话; spdxth : 视频单向通话(监控); NVR0824 : NVR设备,大于8路,小于等于24路; WifiKeepalive : Wifi保活(低功耗产品); Alexa : Alexa接入; Google : Google接入; 注意:此字段可能返回 null,表示取不到有效值。 |
ProductCate | Integer | 产品类别,0 : 普通视频设备;1 : NVR设备 注意:此字段可能返回 null,表示取不到有效值。 |
ProductRegion | String | 产品地域 China-Mainland(中国大陆) China-Hong Kong, Macao and Taiwan(港澳台地区) America(美国) Europe(欧洲) India(印度) Other-Overseas(其他境外地区) 注意:此字段可能返回 null,表示取不到有效值。 |
ProductData
产品信息
被如下接口引用:DescribeProduct, DescribeProducts。
名称 | 类型 | 描述 |
---|---|---|
ProductId | String | 产品ID 注意:此字段可能返回 null,表示取不到有效值。 |
ProductName | String | 产品名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProductDescription | String | 产品描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | Integer | 创建时间,UNIX 时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
IotModelRevision | Integer | 物模型发布版本号,0代表物模型尚未发布 注意:此字段可能返回 null,表示取不到有效值。 |
SecretKey | String | 产品密钥 注意:此字段可能返回 null,表示取不到有效值。 |
Features | Array of String | 设备功能码 注意:此字段可能返回 null,表示取不到有效值。 |
ProductModel | String | 产器型号(APP产品,为APP包名) 注意:此字段可能返回 null,表示取不到有效值。 |
ChipManufactureId | String | 主芯片厂商id 注意:此字段可能返回 null,表示取不到有效值。 |
ChipId | String | 主芯片型号 注意:此字段可能返回 null,表示取不到有效值。 |
ProductCate | Integer | 产品类别,0:普通视频设备;1:NVR设备 注意:此字段可能返回 null,表示取不到有效值。 |
ProductRegion | String | 产品地区 China-Mainland(中国大陆) China-Hong Kong, Macao and Taiwan(港澳台地区) America(美国) Europe(欧洲) India(印度) Other-Overseas(其他境外地区) 注意:此字段可能返回 null,表示取不到有效值。 |
AccessMode | Integer | 接入模型,bit0是0:公版小程序未接入,bit0是1:公版小程序已接入 注意:此字段可能返回 null,表示取不到有效值。 |
Os | String | linux,android,liteos 注意:此字段可能返回 null,表示取不到有效值。 |
RechargeRecord
充值记录列表
被如下接口引用:DescribeRechargeRecords。
名称 | 类型 | 描述 |
---|---|---|
WaterId | Integer | 流水记录号。 注意:此字段可能返回 null,表示取不到有效值。 |
BalanceBeforeRecharge | Integer | 充值前的余额,单位0.01元。 注意:此字段可能返回 null,表示取不到有效值。 |
Money | Integer | 充值金额,单位0.01元。 注意:此字段可能返回 null,表示取不到有效值。 |
OperateTime | Integer | 充值时间, UTC值。 注意:此字段可能返回 null,表示取不到有效值。 |
RegisteredStatus
终端用户注册状态
被如下接口引用:DescribeRegistrationStatus。
名称 | 类型 | 描述 |
---|---|---|
CunionId | String | 终端用户的唯一ID |
IsRegisted | Boolean | 注册状态 |
RenewCertificate
刷新证书信息
被如下接口引用:RenewUploadTest。
名称 | 类型 | 描述 |
---|---|---|
TempCertificate | CertificateInfo | 刷新证书信息 注意:此字段可能返回 null,表示取不到有效值。 |
StorageOrder
云存订单信息
被如下接口引用:CreateStorageService, DeliverStorageService, DescribeStorageService, RefundStorageService。
名称 | 类型 | 描述 |
---|---|---|
OrderId | String | 定单唯一性ID 示例值:59 |
PkgId | String | 云存套餐ID 示例值:yc1m3d |
Status | Integer | 定单服务状态 1;订单正在使用。 2:订单未开始。 3:订单已经使用过,现在暂时未开始使用(该订单从其他服务转移而来)。 4:订单已过期。 5:订单已被退订。 6:定单已被转移到其他云存服务。 示例值:2 |
StartTime | Integer | 定单服务生效时间 示例值:1605343244 |
EndTime | Integer | 定单服务失效时间 示例值:1607935245 |
SystemType
系统类型
被如下接口引用:DescribeOsList。
名称 | 类型 | 描述 |
---|---|---|
Android | Array of OsData | 安卓系统 注意:此字段可能返回 null,表示取不到有效值。 |
Linux | Array of OsData | linux系统 注意:此字段可能返回 null,表示取不到有效值。 |
LiteOs | Array of OsData | LiteOs系统 注意:此字段可能返回 null,表示取不到有效值。 |
TraceStatus
布尔值,标识指定设备是否在白名单中
被如下接口引用:DescribeTraceStatus。
名称 | 类型 | 描述 |
---|---|---|
Tid | String | 设备TID |
IsExist | Boolean | 设备追踪状态 |
VersionData
固件版本详细信息
被如下接口引用:DescribeOtaVersions。
名称 | 类型 | 描述 |
---|---|---|
ProductId | String | 产品ID 注意:此字段可能返回 null,表示取不到有效值。 |
OtaVersion | String | 固件版本号 注意:此字段可能返回 null,表示取不到有效值。 |
PubStatus | Integer | 版本类型 1未发布 2测试发布 3正式发布 4禁用 注意:此字段可能返回 null,表示取不到有效值。 |
VersionUrl | String | 固件版本存储路径URL 注意:此字段可能返回 null,表示取不到有效值。 |
FileSize | Integer | 文件大小,byte 注意:此字段可能返回 null,表示取不到有效值。 |
Md5 | String | 文件校验码 注意:此字段可能返回 null,表示取不到有效值。 |
OldVersions | String | 指定的允许升级的旧版本,PubStatus=3时有效 注意:此字段可能返回 null,表示取不到有效值。 |
Tids | String | 指定的允许升级的旧设备id,PubStatus=2时有效 注意:此字段可能返回 null,表示取不到有效值。 |
GrayValue | Integer | 灰度值(0-100),PubStatus=3时有效,表示n%的升级总量 注意:此字段可能返回 null,表示取不到有效值。 |
PublishTime | Integer | 最近一次发布时间,UNIX时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
ActiveCount | Integer | 此版本激活的设备总数 注意:此字段可能返回 null,表示取不到有效值。 |
OnlineCount | Integer | 此版本在线的设备总数 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | Integer | 上传固件文件的时间,UNIX时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
UploadTime | Integer | 发布记录的最后变更时间,UNIX时间戳,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
ModifyTimes | Integer | 该固件版本发布的变更次数 注意:此字段可能返回 null,表示取不到有效值。 |
Remark | String | 备注信息 注意:此字段可能返回 null,表示取不到有效值。 |
Contents | Contents | 版本发布的描述信息,需要国际化,可以为空 注意:此字段可能返回 null,表示取不到有效值。 |
AliveInMonthCnt | Integer | 月活设备数,当月第一天开始有上线的设备数量。 注意:此字段可能返回 null,表示取不到有效值。 |