更新时间:2021-12-27 GMT+08:00
分享

API概览

表1 VIS API概览

功能

API

说明

服务开通管理

开通服务

此接口用于用户申请开通视频接入服务。

说明:目前"华北-北京一"和"华东-上海二"区域不支持新用户开通。

获取服务开通信息

该接口用于获取服务开通信息。

说明:目前"华北-北京一"和"华东-上海二"区域不支持新用户开通。

视频流管理

创建视频流

该接口用于创建视频流。

更新视频流

该接口用于更新视频流的详情,包括RTMP以及HTTP-FLV类型视频流。对于GB/T28181设备自动关联的视频流,不能通过该接口进行更新。

删除视频流

此接口用于删除指定视频流。

更新转储信息

此接口用于更新视频转储信息。创建的视频流默认没有转储信息,即视频数据不会保存。更新转储信息后可以将视频流保存到指定的存储媒介,如OBS。后续用户可以从OBS上获取到转储的视频。

获取视频流信息

此接口用于获取指定视频流的详细信息。

获取视频流列表

此接口用于获取所有视频流的详细信息。

获取视频流地址

此接口用于获取指定视频流的地址。该地址用于进行视频流推流或者拉流。

设备管理

创建GB/T28181设备通道

此接口用于创建GB/T28181设备(摄像头、网络硬盘录像机等)通道。

更新GB/T28181设备通道信息

该接口用于改变通道关联的视频流名称后缀,或者进行“视频邀约”“取消邀约”,以激活/断开GB/T28181设备的视频传输。

获取设备列表

此接口用于获取已注册上的GB/T28181设备列表。

更新GB/T28181设备通道接入策略

该接口用于设置GB/T28181设备的视频接入策略。用户可以通过设置接入策略定时自动进行设备的接入。

获取NVR设备通道列表

此接口用于获取已注册上的NVR设备通道列表。

更新NVR设备通道列表

该接口用于更新NVR设备的通道列表。

删除GB/T28181设备

此接口用于删除指定设备。

凭证管理

创建GB/T28181凭证

该接口用于创建GB/T28181凭证,该凭证用于GB/T28181设备注册时使用。

获取GB/T28181凭证列表

该接口用于获取所有GB/T28181凭证。

删除GB/T28181凭证

该接口用于删除GB/T28181用户的凭证。

更新GB/T28181凭证

该接口用于更新GB/T28181用户名密码凭证。

创建AK/SK凭证

该接口用于创建AK/SK凭证,AK/SK用于RTMP视频流推流时的鉴权。

获取AK/SK凭证列表

该接口用于获取所有AK/SK凭证。

删除AK/SK凭证

该接口用于删除AK/SK凭证。

更新AK/SK凭证

该接口用于更新AK/SK凭证。

设备指标统计

获取新上线设备列表

该接口用于获取今天新上线(即之前没有上线记录)的GB/T28181设备列表。

获取新掉线设备列表

该接口用于获取今天新掉线的GB/T28181设备列表。

获取长期不在线设备列表

该接口用于获取三天以上不在线的GB/T28181设备列表。

获取近期掉线的设备列表

该接口用于获取状态为“已下线”,且三天内有上线动作的GB/T28181设备。

获取在线未推流设备列表

该接口用于获取曾经在线,且从来没有视频数据推送的GB/T28181设备列表。

获取视频包接收率

该接口用于获取当天有视频接入的GB/T28181设备的平均视频包接受率的列表。

获取曾经上线的设备列表

该接口用于获取曾经上线的GB/T28181设备列表,即只要上线过的设备信息都会显示。

obs桶策略管理

更新桶授权

该接口用于用户更新桶授权。

获取桶信息列表

该接口用于用户获取桶信息列表。

相关文档