You need to enable JavaScript to run this app.
导航

OpenAPI 概览

最近更新时间2023.10.13 14:59:21

首次发布时间2021.11.25 17:24:44

慢直播产品面向音视频端侧设备,提供一体化的视频接入、视频分发、视频存储回放、视频录制回放和智能分析服务。

我们开放了服务管理、空间管理、设备管理、视频流管理、模板管理等相关业务的 OpenAPI。本文档为您提供具体的 API 描述、语法、参数说明及示例等,您可以调用 API 管理慢直播服务资源、开展业务。

接口列表

服务管理相关接口

慢直播服务和账号管理相关的接口如下:

接口名称
接口功能
GetAccount检查账号开通慢直播服务的状态
CreateAccount为账号开通慢直播服务
UpdateAccount更新账号开通慢直播服务的计费模式

空间管理相关接口

空间是用户在慢直播控制台内配置视频接入、分发、存储和分析任务的工程项目。空间管理相关的接口如下:

接口名称
接口功能
CreateSpace创建空间
DeleteSpace删除空间
GetSpace查询指定空间的详细信息
UpdateSpace更新指定空间的配置信息
StartSpace / StopSpace启用或停用指定空间
ListSpaces查询已创建的空间列表信息
AddSpaceDomain在指定空间内添加域名
UpdateSpaceDomain更新空间的默认域名
ListSpaceDomains查询指定空间的域名列表
GetSpaceDomain查询指定域名的详细信息
DeleteSpaceDomain删除域名
UploadCert上传证书
ListCertificates查询证书列表
CertDetail查看指定证书的详细信息
BindCert将域名与证书相绑定
UnbindCert将已绑定证书的域名解除绑定
DeleteCert删除指定证书
UpdateAuthInSpace开启指定域名的时间戳防盗链
DisableAuthInSpace关闭指定域名的时间戳防盗链
GetSpaceTemplate查看指定空间配置的模板信息
SetSpaceTemplate为指定空间配置截图模板或录制模板
CheckBindTemplate查询指定模板已配置的空间信息
CancelBindTemplate释放指定空间已配置的指定模板类型

设备管理相关接口

视频流采集设备管理相关的接口如下:

接口名称
接口功能
ListDevices
查询指定空间内已接入的设备列表
CreateDevice
在指定空间内创建单个设备
GetDevice
查询指定设备的信息
GetDeviceChannels(已废弃)
查询指定设备的通道列表
GetDeviceChannelsV2
查询指定设备的通道列表
UpdateDevice
更新指定设备的信息
StartDevice / StopDevice
启用或停用指定设备
DeleteDevice
删除指定设备
ListDeviceScreenshots
查询指定设备在云端保存的截图列表
FreshDevice
刷新设备
GenSipID
自动生成创建设备时所需的设备国标 ID

视频流管理相关接口

视频流管理相关的接口如下:

接口名称
接口功能
ListStreams
查询指定空间内已创建的视频流列表
GetStream
查询指定视频流的详细信息
CreateStream
在指定空间内创建视频流
UpdateStream
更新指定视频流的信息
StartStream启用指定视频流
StopStream / ForbidStream / UnforbidStream停用、禁用或解禁指定视频流
DeleteStream
删除指定视频流
StreamLogs查询指定视频流在某个时间段的推流记录信息
GetStreamData查询指定视频流推流的帧率和码率等信息
StatStream查询来自直播的视频流数据

本地回放相关接口

本地回放相关的接口如下:

接口名称
接口功能
GetRecordList(已废弃)查询设备本地录像回放列表
GetRecordListV2查询设备本地录像回放列表
PlayBackStart开始录像回放
PlayBackStop结束录像回放
PlayBackControl录像回放控制
GetGBMediaFinish判断录像回放是否已经结束
PlayBackStat查询回放流状态
LocalMediaDownload开始下载设备本地录像文件
GetLocalDownload查询可下载的本地录像文件列表

录像计划相关接口

录像计划相关的接口如下:

接口名称
接口功能
CreateRecordPlan创建录像计划
UpdateRecordPlan更新录像计划
GetRecordPlan查询录像计划详情
DeleteRecordPlan删除录像计划
ListRecordPlan获取录像计划列表
ListRecordPlanChannels获取录像计划通道列表

录制管理相关接口

视频流录制管理相关接口如下:

接口名称
接口功能
ListDeviceRecords查询指定设备在云端保存的视频录像列表
CloudRecordPlay查询在云端保存的视频录像的播放地址
StreamStartRecord对指定视频流启动录像任务
StreamStopRecord停止视频流的录像任务
GetStreamRecord根据录像任务 ID,查询指定录像任务的结果
DeleteStreamRecord根据录像任务 ID,删除录像

报警管理相关接口

报警管理相关的接口如下:

接口名称
接口功能
SetAlarmGuard
为指定设备开启或关闭报警事件通知功能
ResetAlarm
重置指定设备的报警事件通知功能
ListAlarmNotify
查询指定设备在指定时间段内的报警事件信息
DeleteAlarmNotify
删除指定报警记录

设备控制相关接口

设备控制相关的接口如下:

接口名称
接口功能
CloudControl发送控制指令和参数,进行云台控制
QueryPresetInfo获取设备预置位信息
CruiseControl通道巡航控制
SetCruiseTrack设置巡航路径(创建或修改巡航路径)
GetCruiseTrack查询指定通道巡航路径的详细信息
ListCruiseTracks查询通道巡航路径列表信息
DeleteCruiseTrack删除指定巡航组
StartCruiseTrack指定巡航组开始巡航
StopCruiseTrack停止巡航

模板管理相关接口

模板管理相关的接口如下:

接口名称
接口功能
ListScreenshotTemplates
查询已创建的截图模板列表
GetScreenshotTemplate
查询指定截图模板的详细信息
CreateScreenshotTemplate
创建截图模板
UpdateScreenshotTemplate
编辑指定截图模板的信息
DeleteScreenshotTemplate
删除指定截图模板
ListRecordTemplates
查询已创建的录制模板列表
GetRecordTemplate
查询指定录制模板的详细信息
CreateRecordTemplate
创建录制模板
UpdateRecordTemplate
编辑指定录制模板的信息
DeleteRecordTemplate
删除指定录制模板
ListAITemplates
查询已创建的 AI 模板列表
GetAITemplate
查询指定 AI 模板的详细信息
CreateAITemplate
创建 AI 模板
UpdateAITemplate
编辑指定 AI 模板的信息
DeleteAITemplate
删除指定 AI 模板
CreateTransTemplate
创建转码模板

国标级联(虚拟组织树)相关接口

虚拟组织树相关的接口如下:

接口名称
接口功能
ListGroupTreeNodes获取指定空间下所有虚拟组织树节点的信息
GetGroupTreeNode获取指定节点的详细信息
AddGroupTreeNode在指定空间下新增节点
UpdateGroupTreeNode修改指定节点的名称和描述
BindDeviceToGroupTreeNode修改指定节点绑定的设备
DeleteGroupTreeNodes删除节点
GetDevicesByGroupTreeNode根据节点获取绑定的设备列表

国标级联(上级平台)相关接口

上级平台相关的接口如下:

接口名称
接口功能
ListCascadePlatform查询已创建的上级平台列表
GetCascadePlatform获取指定上级平台的信息
CreateCascadePlatform创建上级平台
UpdateCascadePlatform修改指定上级平台的信息
DeleteCascadePlatform删除上级平台
BatchDeleteCascadePlatform批量删除上级平台

国标级联(级联任务)相关接口

级联任务相关的接口如下:

接口名称
接口功能
ListCascadeTask查询已创建的级联任务列表
GetCascadeTask获取指定级联任务的信息
CreateCascadeTask创建级联任务
UpdateCascadeTask修改指定级联任务的信息
DeleteCascadeTask删除级联任务
BatchDeleteCascadeTask批量删除级联任务
GetGroupNodesByCascadeTask获取共享节点的信息
ShareGroupNodesToCascadeTask共享节点
StartCascadeTask启动级联任务
StopCascadeTask停用级联任务

语音对讲相关接口

语音对讲相关的接口如下:

接口名称
接口功能
StartVoiceTalk开始语音对讲
StopVoiceTalk结束语音对讲

视图管理(视图空间管理)相关接口

视图空间管理相关的接口如下:

接口名称
接口功能
ListStructuredViewSpaces查询已创建的视图空间列表
GetStructuredViewSpace获取指定视图空间的信息
CreateStructuredViewSpace创建视图空间
UpdateStructuredViewSpace修改指定视图空间的信息
DeleteStructuredViewSpace删除视图空间
EnableStructuredViewSpace启用视图空间
DisableStructuredViewSpace停用视图空间

视图管理(视图设备接入)相关接口

视图设备接入管理相关的接口如下:

接口名称
接口功能
ListStructuredViews查询已添加的视图设备列表
GetStructuredView获取指定视图设备的信息
CreateStructuredViewCode生成视图接入编码
CreateStructuredView添加视图设备
UpdateStructuredView编辑视图设备
DeleteStructuredView删除视图
EnableStructuredView启用视图
DisableStructuredView停用视图
ListStructuredViewData列举视图数据

视图管理(上级视图管理)相关接口

上级视图管理相关的接口如下:

接口名称
接口功能
ListStructuredViewCascadePlatform查询已创建的上级视图列表
GetStructuredViewCascadePlatform获取指定上级视图的信息
CreateStructuredViewCascadePlatform创建上级视图
UpdateStructuredViewCascadePlatform编辑上级视图
DeleteStructuredViewCascadePlatform删除上级视图
EnableStructuredViewCascadePlatform启用上级视图
DisableStructuredViewCascadePlatform停用上级视图

视图管理(视图库级联管理)相关接口

视图库级联管理相关的接口如下:

接口名称
接口功能
ListStructuredViewCascadeJob查询已创建的级联任务
GetStructuredViewCascadeJob获取指定级联任务的信息
CreateStructuredViewCascadeJob创建级联任务
UpdateStructuredViewCascadeJob更新级联任务
DeleteStructuredViewCascadeJob删除级联任务
EnableStructuredViewCascadeJob启动级联任务
DisableStructuredViewCascadeJob停止级联任务

智能应用管理相关接口

智能应用管理相关的接口如下:

接口名称
接口功能
CreateLib创建对象库(车辆库)
UpdateLib更新对象库信息(车辆库)
ListLib查询已创建的对象库列表
GetLib查询已创建的对象库的详细信息
DeleteLib删除对象库
ListLibInfo查询指定对象库中已注册的对象列表
GetLibInfo查询指定对象的详细信息
CreateLibInfo在指定对象库中添加对象信息
UpdateLibInfo更新指定对象的信息
DeleteLibInfo删除指定对象的信息
ListAIApp查询已创建的智能应用列表
GetAIApp查询指定智能应用的详细信息
CreateAIApp创建智能应用
UpdateAIApp更新指定智能应用的信息
StartAIApp启动指定智能应用
StopAIApp停止指定智能应用
DeleteAIApp删除指定智能应用
ListLibItem查询指定应用对指定对象的布控匹配结果数量
ListAppResult查询指定应用对指定对象的布控结果详情

慢直播媒体处理相关接口

慢直播媒体处理相关的接口如下:

接口名称
接口功能
ListSlowLive查询当前账号下已添加的所有慢直播媒体处理应用信息
CreateSlowLive创建慢直播媒体处理应用
UpdateSlowLive编辑指定慢直播媒体处理应用的配置信息
StartSlowLive / StopSlowLive开始运行/停止运行指定慢直播媒体处理应用
DeleteSlowLive删除指定慢直播媒体处理应用
BatchDeleteSlowLive批量删除指定慢直播媒体处理应用

多屏轮播相关接口

多屏轮播相关的接口如下:

接口名称
接口功能
ListStreamPollingTasks查询已创建的轮播任务
GetStreamPollingTask查询指定轮播任务的信息
CreateStreamPollingTask创建轮播任务
UpdateStreamPollingTask更新轮播任务
DeleteStreamPollingTask删除轮播任务

数据工程相关接口

业务数据统计相关的接口如下:

接口名称
接口功能
GetDataProjectWithBindWidthAndFlow查询指定空间在指定时间段的带宽和流量信息
GetTotalData查询当前账号前一日的业务数据(带宽、流量)
GetTotalDeviceAndStream查询当前账号接入设备和视频流的数据
GetPushStreamCnt查询指定空间在某个时间段内的推流数据