API概述
本文档介绍了视频监控服务的各类API，您可以分别查看各API的具体信息。
空间管理相关
| API | 说明 |
|---|---|
| 创建空间 | 用于创建新的业务空间 |
| 删除空间 | 用于删除业务空间 |
| 更新空间 | 用户更新空间的配置信息操作 |
| 查询空间信息 | 用户查询业务空间的详细信息 |
| 获取空间列表 | 用户获取空间列表 |
| 禁用空间 | 禁用空间操作 |
| 启用空间 | 启用空间操作 |
| 消息通知 | 直播流状态的实时变化、设备状态的实时变化，视频录制/截图成功的事件通知 |
域名管理相关
| API | 说明 |
|---|---|
| 创建域名 | 用于在某空间下创建新的域名 |
| 删除域名 | 用于删除空间下的域名 |
| 更新域名 | 更新域名,例如开启或关闭时间戳防盗链,添加或删除https证书等 |
| 查询域名 | 查询域名信息 |
| 获取域名列表 | 获取某个空间下的域名列表 |
| 获取https证书列表 | 获取https ssl证书列表 |
| 配置域名戳防盗链 | 修改域名下的防盗链信息 |
流管理相关
| API | 说明 |
|---|---|
| 创建流 | 用于创建视频流 |
| 删除流 | 用于删除已添加的视频流 |
| 更新流 | 用于更新流的配置新 |
| 查询流信息 | 用于查询流的详细信息 |
| 获取流列表 | 用于获取流列表信息 |
| 获取流地址 | 用于获取推拉流地址信息 |
| 启用流 | 启用流操作 |
| 禁用流 | 禁用流操作 |
| 查询流实时信息 | 用于查询实时流的帧率、码率 |
| 查询推流记录 | 用于查询流的推流记录 |
设备管理相关
| API | 说明 |
|---|---|
| 创建设备 | 用于创建设备 |
| 批量创建设备 | 用于批量创建设备 |
| 获取批次列表 | 用于查询批量创建设备的批次记录 |
| 获取批次设备信息 | 用于查询批次下所有设备的信息 |
| 删除批次 | 用于删除批次下所有的设备 |
| 删除设备 | 用于删除设备 |
| 更新设备 | 用于更新设备配置信息 |
| 查询设备信息 | 用于查询设备信息 |
| 获取设备列表 | 用于获取设备列表信息 |
| 获取通道列表 | 用于查询通道列表信息 |
| 删除通道 | 用于删除网络录像机的指定通道 |
| 启动设备拉流 | 用于启动国标设备拉流 |
| 停止设备拉流 | 用于结束国标设备拉流 |
| 语音对讲 | 用于对设备发起语音对讲 |
| 获取设备地理位置用于获取设备地理位置信息 |
模板管理相关
| API | 说明 |
|---|---|
| 创建模板 | 用于创建录制、截图等模板 |
| 删除模板 | 用户删除指定的模板 |
| 更新模板 | 用于更新录制、截图等模板的配置信息 |
| 查询模板信息 | 用于查询指定模板的配置信息 |
| 获取模板列表 | 用于获取模板列表信息 |
录制管理相关
| API | 说明 |
|---|---|
| 启动按需录制 | 本接口用于对指定流启动按需录制 |
| 停止按需录制 | 本接口用于对指定流停止按需录制 |
| 查询录制记录 | 用于查询视频流的录制的记录 |
| 删除录制片段 | 用于删除通过qvs录制模板生成的视频文件 |
| 录制视频片段合并 | 该接口用于将多个录制文件合并成一个大的视频文件 |
| 录制回放 | 本接口用于查询指定时间段的录像记录进行录像回放 |
| 按需截图 | 本接口用于对指定流立即截图一次，适用于按需截图场景 |
| 删除截图 | 用于删除通过qvs截图模板生成的截图文件 |
| 获取截图列表 | 用于查询视频流截图的记录 |
| 获取直播封面截图 | 用于查询视频流的封面 |
本地录像管理相关
| API | 说明 |
|---|---|
| 本地录像回放控制 | 用于本地录像回放的控制，如快进、快退、慢放、拖动播放、暂停等操作 |
| 本地录像下载 | 用于下载存储在NVR或者IPC的SD卡中的录像文件 |
| 查询本地录像列表 | 用于查询设备本地录像列表 |
| 本地录像上传云端存储 | 用于将本地录像文件上传到云端并进行录制存储的操作 |
| 终止本地录像上传云端存储 | 用于终止本地录制文件上传云端录制的操作 |
PTZ相关
| API | 说明 |
|---|---|
| 云台控制 | 用于对摄像头进行 转动镜头，如水平、垂直、缩放等操作 |
| 变焦控制 | 用于摄像头的变焦控制 |
| 光圈控制 | 用于摄像头的光圈控制 |
| 预置位控制 | 用于预置位的管理 |
| 获取预置位列表 | 用于摄像头端获取预置位列表信息 |
国标报警相关接口
| API | 说明 |
|---|---|
| 获取国标报警事件列表 | 用于获取设备国标报警事件列表 |
数据统计相关
| API | 说明 |
|---|---|
| 查询流量数据 | 本接口用于查询用户或者空间下的流量数据 |
| 查询带宽数据 | 本接口用于查询用户或者空间下的带宽数据 |
| 查询国标接入设备数 | 本接口用于查询用户或者空间下接入的国标设备数量 |
文档反馈
(如有产品使用问题，请 提交工单)
售前 
售后 