AbnormalEvents
异动事件走势列表
被如下接口引用：DescribeAbnormalEvents。
| 名称 | 类型 | 描述 |
|---|---|---|
| Date | String | 对应查询日期 示例值：2021-06-01 |
| Info | Array of AbnormalEventsInfo | 列表信息 |
AbnormalEventsInfo
异动事件走势元素
被如下接口引用：DescribeAbnormalEvents。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | Integer | 类型值 示例值：5 |
| Count | Integer | 类型总数 示例值：0 |
AllDeviceInfo
查询全部设备出参
被如下接口引用：DescribeAllDeviceList, DescribeDevice, DescribeDeviceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceId | String | 是 | 设备唯一标识 示例值：99299744331320000002_99299744331320000002 |
| DeviceType | Integer | 是 | 设备类型；2：IPC 示例值：2 |
| Status | Integer | 否 | 设备状态；0：设备不在线；1：设备在线；2：设备隔离中；3：设备未注册 示例值：1 |
| CreateTime | Integer | 否 | 创建时间 示例值：1702969011 |
| ExtraInformation | String | 否 | 设备扩展属性 示例值：IP Camera |
| NickName | String | 否 | 设备名称 示例值：dahua001 |
| GroupPath | String | 否 | 设备绑定分组路径 示例值：/gro-usk7xtpc |
| DeviceCode | String | 否 | 设备编码 示例值：99299744331320000002 |
| IsRecord | Integer | 否 | 是否存在录像,，0:不存在；1：存在 示例值：1 |
| Recordable | Integer | 否 | 该设备是否可录制 示例值：true |
| Protocol | String | 否 | 设备接入协议 示例值：GB/T 28181 |
| GroupId | String | 否 | 组Id 示例值：gro-zn3ro30w |
| GroupName | String | 否 | 组名 示例值：一个组的名字 |
ChannelDetail
国标通道详细信息
被如下接口引用：DescribeChannels。
| 名称 | 类型 | 描述 |
|---|---|---|
| ChannelName | String | 通道名称 示例值：Camera 01 |
| ChannelId | String | 通道唯一标识 示例值：34020000001180000036_34020000001320000092 |
| ChannelType | Integer | 通道类型 0：未知；1：视频通道；2：音频通道；3：告警通道 示例值：1 |
| ChannelCode | String | 20位国标通道编码 示例值：34020000001320000092 |
| ExtraInformation | String | 通道扩展信息 示例值：IP Camera |
| Status | Integer | 通道在线状态 示例值：1 |
| IsRecord | Integer | 通道是否存在录像标识 0：无录像；1：有录像 示例值：1 |
| DeviceId | String | 通道所属设备唯一标识 示例值：34020000001180000036_34020000001180000036 |
| BusinessGroupId | String | 通道所属虚拟组织的ID 示例值：34020000001180000036 |
ChannelItem
GB28181通道
被如下接口引用：CreateRecordingPlan, CreateScene, DescribeBindSceneChannels, DescribeRecordingPlanById, DescribeRecordingPlans, ModifyBindRecordingPlan, ModifyBindSceneChannels。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceId | String | 是 | 设备唯一标识 示例值：34020000001180000036_34020000001320000092 |
| ChannelId | String | 是 | 通道唯一标识 示例值：34020000001180000036_34020000001320000092 |
DescribeDeviceStreamsData
DescribeDeviceStreams的出参复杂类型
被如下接口引用：DescribeChannelLiveStreamURL, DescribeChannelStreamURL, DescribeDeviceStreams。
| 名称 | 类型 | 描述 |
|---|---|---|
| RtspAddr | String | rtsp地址 示例值：rtsp://somedomain.com/live/9 |
| RtmpAddr | String | rtmp地址 示例值：rtmp://somedomain.com/live/9 |
| HlsAddr | String | hls地址 示例值：http://somedomain.com/live/9/hls.m3u8 |
| FlvAddr | String | flv地址 示例值：http://somedomain.com/live/0.live.flv |
DescribeRecordStreamData
DescribeRecordStreamData 复杂类型
被如下接口引用：DescribeChannelLocalRecordURL, DescribeRecordStream。
| 名称 | 类型 | 描述 |
|---|---|---|
| RtspAddr | String | Rtsp地址 示例值：NULL |
| RtmpAddr | String | Rtmp地址 示例值：rtmp://dev-pl.video.tencentcs.com/live/1099154940?txSecret=33f87 |
| HlsAddr | String | Hls地址 示例值：https://dev-pl.video.tencentcs.com/live/1099154940.m3u8?txSecret |
| FlvAddr | String | Flv地址 示例值：https://dev-pl.video.tencentcs.com/live/1099154940.flv?txSecret= |
| StreamId | String | 流Id 示例值：1099154940 |
DevGroupInfo
设备所在分组信息
被如下接口引用：DescribeDeviceGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceId | String | 否 | 设备唯一标识 示例值：19299744331320000002_19299744331320000002 |
| GroupId | String | 否 | 分组ID 示例值：gro-30to7hxt |
| GroupPath | String | 否 | 分组路径 示例值：/gro-30to7hxt |
| ParentId | String | 否 | 父分组ID 示例值：group_root |
| Error | String | 否 | 设备错误，仅在用户没权限或者设备已删除时返回具体结果 示例值：该设备分组不存在 |
DeviceItem
用于描述唯一一个设备
被如下接口引用：CreateRecordPlan, CreateScene, DescribeBindSceneDevices, GetRecordPlanByDev, GetRecordPlanById, GetRecordPlans, ModifyBindSceneDevice, UpdateRecordPlan。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceId | String | 否 | 设备唯一标识 示例值：34020000001180000036_34020000001320000092 |
| ChannelId | String | 否 | 通道唯一标识 示例值：34020000001180000036_34020000001320000092 |
DeviceMonitorValue
查询设备统计返回值
被如下接口引用：DescribeDeviceMonitorData。
| 名称 | 类型 | 描述 |
|---|---|---|
| Value | Float | 统计值 示例值：2 |
| Time | Integer | 统计时间 示例值：1624204800 |
Events
设备事件列表
被如下接口引用：DescribeDeviceEvent。
| 名称 | 类型 | 描述 |
|---|---|---|
| EventTime | Integer | 开始时间，秒级时间戳 示例值：1624204800 |
| EventType | Integer | 事件类型 1:注册 2:心跳 4:录制异常 5:播放异常 6:流中断 示例值：1 |
| EventDesc | String | 事件描述 示例值：succ |
| DeviceType | Integer | 设备类型 示例值：2 |
| DeviceAddress | String | 设备地址 示例值：10.0.16.80:9455 |
| DeviceId | String | 设备Id 示例值：99933020581320000255 |
| ChannelId | String | 通道Id 示例值：99933020581320000255 |
| EventLog | String | 事件日志 示例值：设备在11:30注册成功 |
| DeviceName | String | 设备备注名称 示例值：设备备注名称1 |
GroupDeviceItem
分组下设备信息
被如下接口引用：DescribeGroupDevices, DescribeIPCChannels。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceId | String | 是 | 设备唯一标识 示例值：99299744331329000002_99299744331329000002 |
| NickName | String | 否 | 设备名称 示例值：myipc |
| Status | Integer | 否 | 设备状态 示例值：1 |
| ExtraInformation | String | 否 | 扩展信息 示例值：IP Camera |
| DeviceType | Integer | 否 | 设备类型 示例值：1 |
| RTSPUrl | String | 否 | rtsp地址 示例值：rtsp://somedomain.com/live/9 |
| DeviceCode | String | 否 | 设备编码 示例值：99299744331329000002 |
| IsRecord | Integer | 否 | 是否存在录像 示例值：1 |
| Recordable | Integer | 否 | 该设备是否可录制 示例值：1 |
| Protocol | String | 否 | 设备接入协议 示例值：GB/T 28181 |
| CreateTime | Integer | 否 | 设备创建时间 示例值：1 |
| ChannelNum | Integer | 否 | 设备通道总数 示例值：1 |
| VideoChannelNum | Integer | 否 | 设备视频通道总数 示例值：1 |
GroupInfo
分组信息详情
被如下接口引用：DescribeGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupId | String | 否 | 分组ID 示例值：gro-usk8xtpc |
| GroupName | String | 否 | 分组名称 示例值：myipc |
| GroupType | String | 否 | 分组类型 示例值：2 |
| GroupPath | String | 否 | 分组路径 示例值：/gro-usk8xtpc |
| ParentId | String | 否 | 父分组ID 示例值：group_root |
| GroupDescribe | String | 否 | 分组描述 示例值：this is myipc |
| ExtraInformation | String | 否 | 扩展信息 示例值：IP Camera |
| CreateTime | Integer | 否 | 创建时间 示例值：1702969011 |
| GroupStatus | Integer | 否 | 分组状态 示例值：1 |
| Error | String | 否 | 设备不存在时产生的错误 示例值：设备不存在 |
GroupItem
分组信息
被如下接口引用：DescribeGroupById, DescribeGroupByPath, DescribeSubGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupName | String | 是 | 分组名称 示例值：myipc |
| ParentId | String | 是 | 父分组ID 示例值：usk7xtpc |
| GroupId | String | 是 | 分组ID 示例值：gro-usk7xtpc |
| GroupPath | String | 否 | 分组路径 示例值：/gro-usk7xtpc |
| GroupDescribe | String | 否 | 分组描述 示例值：This is my first device |
| DeviceNum | Integer | 否 | 分组绑定设备数 示例值：1 |
| SubGroupNum | Integer | 否 | 子分组数量 示例值：2 |
| ExtraInformation | String | 否 | 分组附加信息 示例值：IP Camera |
| GroupType | String | 否 | 分组类型 示例值：1 |
| CreateTime | Integer | 否 | 创建时间 示例值：1702969011 |
| GroupStatus | Integer | 否 | 分组状态 示例值：1 |
LiveChannelInfo
频道信息
被如下接口引用：DescribeLiveChannelList。
| 名称 | 类型 | 描述 |
|---|---|---|
| LiveChannelId | String | 频道ID 示例值：cea6f74f29164253b43411fd888f4dc3 |
| LiveChannelName | String | 频道名称 示例值：001 |
| LiveChannelType | Integer | 频道类型 示例值：1 |
| LiveStatus | Integer | 通道直播状态：1: 未推流，2: 推流中 示例值：1 |
| PushStreamAddress | String | 推流地址 示例值：rtmp://:0/liveFixed/cea6f74f29164253b43411fd888f4dc3 |
| CreateTime | String | 创建时间 示例值：2021-11-08 19:26:16 |
| UpdateTime | String | 修改时间 示例值：2021-11-08 19:26:16 |
LiveChannelItem
直播频道详情
被如下接口引用：DescribeChannelsByLiveRecordPlan。
| 名称 | 类型 | 描述 |
|---|---|---|
| ChannelId | String | 频道ID 示例值：“channel_live_001” |
| ChannelName | String | 频道名称 示例值："直播001" |
LiveRecordItem
直播录制详情item
被如下接口引用：DescribeLiveVideoList。
| 名称 | 类型 | 描述 |
|---|---|---|
| IntID | Integer | 录制文件自增ID 示例值：1 |
| LiveChannelId | String | 直播频道ID 示例值：cea6f74f29164253b43411fd888f4dc3 |
| ExpectDeleteTime | Integer | 过期时间 示例值：0 |
| RecordTimeLen | Integer | 录制时长 示例值：0 |
| FileSize | Integer | 文件大小 示例值：0 |
| VideoUrl | String | 录制文件url 示例值："http/xx.xx.xx/xx.mp4" |
| RecordPlanId | String | 录制计划ID 示例值：plan-7fqulsjc |
| StartTime | Integer | 录制开始时间 示例值：1631007068 |
| EndTime | Integer | 录制结束时间 示例值：1631007668 |
LiveRecordPlanItem
直播录制计划详情
被如下接口引用：DescribeLiveRecordPlanIds。
| 名称 | 类型 | 描述 |
|---|---|---|
| PlanId | String | 计划ID 示例值：planxxx-0 |
| PlanName | String | 计划名称 示例值：namexxx0 |
MessageForward
消息转发配置信息
被如下接口引用：DescribeMessageForwards。
| 名称 | 类型 | 描述 |
|---|---|---|
| IntId | Integer | 配置ID 示例值：124354 |
| Uin | String | 用户Uin 示例值：1624204800 |
| MessageType | String | json数组， 转发类型 1: 告警 2:GPS 示例值：[1,2] |
| RegionId | String | 区域ID 示例值：gz |
| RegionName | String | 区域名称 示例值：广州 |
| Instance | String | 实例ID 示例值：kafka_instance |
| InstanceName | String | 实例名称 示例值：实例名称 |
| TopicId | String | kafka topic id 示例值：topic1 |
| CreateTime | String | 创建时间 示例值：2021-09-30T17:26:47+08:00 |
| UpdateTime | String | 更新时间 示例值：2021-09-30T17:26:47+08:00 |
| TopicName | String | topic 名称 示例值：topic-kafka |
PresetItem
预置位结构出参
被如下接口引用：DescribePresetList。
| 名称 | 类型 | 描述 |
|---|---|---|
| PresetId | Integer | 预置位ID 示例值：8 |
| PresetName | String | 预置位名称 示例值：Set |
| Status | Integer | 预置位状态 0:未设置预置位 1:已设置预置位 2:已设置预置位&看守位 示例值：0 |
| ResetTime | Integer | 预置位启用时的自动归位时间 示例值：1628075511 |
RecordPlanDetail
录制计划详情
被如下接口引用：DescribeRecordingPlanById, DescribeRecordingPlans。
| 名称 | 类型 | 描述 |
|---|---|---|
| PlanId | String | 计划ID 示例值：planid |
| Name | String | 计划名称 示例值：planname |
| TimeTemplateId | String | 时间模板ID 示例值：templateid |
| TimeTemplateName | String | 时间模板名称 示例值：templatename |
| Channels | Array of ChannelItem | 绑定的通道列表 示例值：[99350367561320000005] |
| RecordStorageTime | Integer | 存储周期（天） 示例值：5 |
RecordPlanItem
录制计划详情
被如下接口引用：GetRecordPlanByDev, GetRecordPlanById, GetRecordPlans。
| 名称 | 类型 | 描述 |
|---|---|---|
| PlanId | String | 计划ID 示例值：planid |
| Name | String | 计划名称 示例值：planname |
| TimeTemplateId | String | 时间模板ID 示例值：templateid |
| TimeTemplateName | String | 时间模板名称 示例值：templatename |
| EventId | Integer | 录制类型 示例值：1 |
| Devices | Array of DeviceItem | 绑定的设备列表 示例值：[99350367561320000005] |
| RecordStorageTime | Integer | 录像存储天数 示例值：1 |
RecordStatistic
大盘统计-录像存储统计 出参RecordStatistic
被如下接口引用：DescribeMonitorDataByDate。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | Integer | 时间戳 示例值：1624204800 |
| Value | RecordStatisticValue | 统计结果 |
RecordStatisticValue
大盘统计-录像存储统计 出参Value
被如下接口引用：DescribeMonitorDataByDate。
| 名称 | 类型 | 描述 |
|---|---|---|
| ExpectTimeLen | Integer | 期望执行时间 秒 示例值：1624204800 |
| RecordTimeLen | Integer | 实际执行时间 秒 示例值：1624204800 |
| FileSize | Float | 存储大小 G 示例值：1.3 |
RecordTaskItem
普通设备的录像详情
被如下接口引用：DescribeVideoList, DescribeVideoListByChannel, GetVideoListByCon。
| 名称 | 类型 | 描述 |
|---|---|---|
| RecordTaskId | String | 录像任务ID 示例值：taskid |
| RecordPlanId | String | 录制计划ID 示例值：planid |
| StartTime | Integer | 本录制片段开始时间 示例值：1611732169 |
| EndTime | Integer | 本录制片段结束时间 示例值：1611732269 |
| EventId | Integer | 录制模式 示例值：1 |
| VideoUrl | String | 本录制片段对应的录制文件URL 示例值：http://xx.mp4 |
| RecordStatus | Integer | 本录制片段当前的录制状态 示例值：0 |
| SceneId | Integer | 场景ID 示例值：234354 |
| WarnId | Integer | 告警ID 示例值：834 |
| RecordId | String | 录制id，NVR下属设备有效 示例值：1611732169_1611732269 |
SceneItem
场景列表元素
被如下接口引用：DescribeScenes。
| 名称 | 类型 | 描述 |
|---|---|---|
| IntId | Integer | 场景ID 示例值：2 |
| Uin | String | 用户UIN 示例值：1624204800 |
| SceneName | String | 场景名称 示例值：测试场景 |
| SceneTrigger | String | 触发规则 示例值：{"2":{"Name":"设备报警","WarnType":{"1":"视频丢失报警","2":"设备防拆报警","3":"存 |
| RecordDuration | Integer | 录制时长 秒 示例值：3600 |
| StoreDuration | Integer | 存储时长 天 示例值：2 |
| CreateTime | String | 创建时间 示例值：2021-10-21T19:22:58+08:00 |
| UpdateTime | String | 修改时间 示例值：2021-10-21T19:22:58+08:00 |
ServerConfiguration
SIIP服务器相关配置项
被如下接口引用：DescribeSIPServer。
| 名称 | 类型 | 描述 |
|---|---|---|
| Host | String | SIP服务器地址 示例值：10.10.10.111 |
| Port | Integer | SIP服务器端口 示例值：30001 |
| Serial | String | SIP服务器编码 示例值：44020009999000000009 |
| Realm | String | SIP服务器域 示例值：4402000000 |
StatisticItem
某天的统计数额
被如下接口引用：DescribeStatisticDetails。
| 名称 | 类型 | 描述 |
|---|---|---|
| Date | String | 日期。格式【YYYY-MM-DD】 示例值：2022-12-32 |
| Sum | Float | 统计数额 示例值：98 |
StreamAddress
拉流地址，只有在推流情况下才有
被如下接口引用：DescribeLiveStream。
| 名称 | 类型 | 描述 |
|---|---|---|
| StreamId | String | 流ID 示例值：100091979791_99335023091329000012_99335023091329000012_live |
| RtspAddr | String | rtsp流地址 示例值：rtsp://somedomain.com/live/0 |
| RtmpAddr | String | rtmp流地址 示例值：rtmp://somedomain.com/live/0 |
| HlsAddr | String | hls流地址 示例值：http://somedomain.com/live/0.live.flv |
| FlvAddr | String | flv流地址 示例值：http://somedomain.com/live/0.live.flv |
TimeTemplateItem
时间模板详情
被如下接口引用：GetTimeTemplateById, GetTimeTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TemplateId | String | 是 | 时间模板ID 示例值：id1 |
| Name | String | 是 | 模板名称 示例值：name1 |
| IsAllWeek | Integer | 是 | 是否全时录制，即7*24小时录制 0-否 1-是 示例值：1 |
| Type | Integer | 否 | 是否为自定义模板 0-否 1-是 示例值：0 |
| TimeTemplateSpecs | Array of TimeTemplateSpec | 否 | 时间片段详情 示例值：[frsdsd-01] |
TimeTemplateSpec
在操作时间模板时，用于描述各个时间片段
被如下接口引用：CreateTimeTemplate, GetTimeTemplateById, GetTimeTemplates, UpdateTimeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DayofWeek | Integer | 是 | 一周中的周几 示例值：2 |
| BeginTime | String | 是 | 时间片段的开始时分。格式【HH:MM】 示例值：12:30 |
| EndTime | String | 是 | 时间片段的结束时分。格式【HH:MM】 示例值：14:30 |
WarningsData
告警列表出参
被如下接口引用：DescribeWarnings。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 唯一ID 示例值：1 |
| DeviceId | String | 设备ID 示例值：99576636581320000310_99782261871320000002 |
| DeviceName | String | 设备名称 示例值：video_dev |
| WarnChannel | String | 告警通道 示例值：99576636581320000310_99782261871320000002 |
| WarnLevel | Integer | 告警级别 1: "一级警情", 2: "二级警情", 3: "三级警情", 4: "四级警情", 示例值：1 |
| WarnLevelName | String | 告警级别名称 示例值：四级警情 |
| WarnMode | Integer | 告警方式 2 设备报警 5 视频报警 6 设备故障报警 示例值：2 |
| WarnModeName | String | 告警方式名称 示例值：视频报警 |
| WarnType | Integer | 告警类型 2: { Name: "设备报警", WarnType: map[int]string{ 1: "视频丢失报警", 2: "设备防拆报警", 3: "存储设备磁盘满报警", 4: "设备高温报警", 5: "设备低温报警", }, }, 5: { Name: "视频报警", WarnType: map[int]string{ 1: "人工视频报警", 2: "运动目标检测报警", 3: "遗留物检测报警", 4: "物体移除检测报警", 5: "绊线检测报警", 6: "入侵检测报警", 7: "逆行检测报警", 8: "徘徊检测报警", 9: "流量统计报警", 10: "密度检测报警", 11: "视频异常检测报警", 12: "快速移动报警", }, }, 6: { Name: "设备故障报警", WarnType: map[int]string{ 1: "存储设备磁盘故障报警", 2: "存储设备风扇故障报警", }, } 示例值：1 |
| Del | Integer | 是否删除 示例值：1 |
| CreateTime | String | 创建时间 示例值：1672471808 |
| UpdateTime | String | 更新时间 示例值：1672482837 |
