更新时间:2024-02-23 GMT+08:00
分享

API概览

视频直播服务对应的接口列表如下所示,在调用视频直播API前,您需要先获取用户Token,Token可以用于调用其他API时鉴权,具体如何调用直播API请参考应用示例

域名管理接口

表1 域名管理接口

接口

说明

POST /v1/{project_id}/domain

创建直播域名

DELETE /v1/{project_id}/domain

删除直播域名

PUT /v1/{project_id}/domain

修改直播域名

GET /v1/{project_id}/domain

查询直播域名

PUT /v1/{project_id}/domains_mapping

域名映射

DELETE /v1/{project_id}/domains_mapping

删除直播域名映射关系

PUT /v1/{project_id}/domain/ipv6-switch

配置域名IPV6开关

GET /v1/{project_id}/cdn/ip-info

查询IP归属信息

PUT /v1/{project_id}/domain/delay

修改播放域名延时配置

GET /v1/{project_id}/domain/delay

查询播放域名延时配置

PUT /v1/{project_id}/domain/pull-sources

修改直播拉流回源配置

GET /v1/{project_id}/domain/pull-sources

查询直播拉流回源配置

转码模板管理接口

表2 转码模板管理接口

接口

说明

POST /v1/{project_id}/template/transcodings

创建直播转码模板

DELETE /v1/{project_id}/template/transcodings

删除直播转码模板

PUT /v1/{project_id}/template/transcodings

配置直播转码模板

GET /v1/{project_id}/template/transcodings

查询直播转码模板

流管理接口

表3 流管理接口

接口

说明

POST /v1/{project_id}/stream/blocks

禁止直播推流

GET /v1/{project_id}/stream/blocks

查询禁止直播推流列表

DELETE /v1/{project_id}/stream/blocks

禁推恢复

PUT /v1/{project_id}/stream/blocks

修改禁推属性

GET /v1/{project_id}/realtime/streams

查询直播中的流信息

通知管理接口

表4 通知管理接口

接口

说明

PUT /v1/{project_id}/notifications/publish

新增、修改直播推流通知配置

GET /v1/{project_id}/notifications/publish

查询直播推流通知配置

DELETE /v1/{project_id}/notifications/publish

删除直播推流通知配置

鉴权管理接口

表5 鉴权管理接口

接口

说明

GET /v1/{project_id}/guard/ip

查询IP黑/白名单

PUT /v1/{project_id}/guard/ip

修改IP黑/白名单

POST /v1/{project_id}/auth/chain

生成URL鉴权串

GET /v1/{project_id}/domain/geo-blocking

查询播放域名的地域限制列表

PUT /v1/{project_id}/domain/geo-blocking

修改播放域名的地域限制配置

GET /v1/{project_id}/guard/key-chain

查询指定域名的Key防盗链配置

PUT /v1/{project_id}/guard/key-chain

更新指定域名的Key防盗链配置

DELETE /v1/{project_id}/guard/key-chain

删除指定域名的Key防盗链配置

截图管理接口

表6 截图管理接口

接口

说明

POST /v1/{project_id}/stream/snapshot

创建直播截图配置

PUT /v1/{project_id}/stream/snapshot

修改直播截图配置

GET /v1/{project_id}/stream/snapshot

查询直播截图配置

DELETE /v1/{project_id}/stream/snapshot

删除直播截图配置

日志管理接口

表7 日志管理接口

接口

说明

GET /v1/{project_id}/logs

获取直播播放日志

录制管理接口

表8 录制管理接口

接口

说明

POST /v1/{project_id}/record/rules

创建录制规则

GET /v1/{project_id}/record/rules

查询录制规则列表

PUT /v1/{project_id}/record/rules/{id}

修改录制规则

DELETE /v1/{project_id}/record/rules/{id}

删除录制规则

GET /v1/{project_id}/record/rules/{id}

查询录制规则配置

POST /v1/{project_id}/record/control

提交录制控制命令

POST /v1/{project_id}/record/indexes

创建录制视频索引文件

录制回调管理接口

表9 录制回调管理接口

接口

说明

POST /v1/{project_id}/record/callbacks

创建录制回调配置

GET /v1/{project_id}/record/callbacks

查询录制回调配置列表

PUT /v1/{project_id}/record/callbacks/{id}

修改录制回调配置

GET /v1/{project_id}/record/callbacks/{id}

查询录制回调配置

DELETE /v1/{project_id}/record/callbacks/{id}

删除录制回调配置

HTTPS证书管理接口

表10 HTTPS证书管理接口

接口

说明

PUT /v1/{project_id}/guard/https-cert

修改指定域名的HTTPS证书配置

GET /v1/{project_id}/guard/https-cert

查询指定域名的HTTPS证书配置

DELETE /v1/{project_id}/guard/https-cert

删除指定域名的HTTPS证书配置

OBS桶管理接口

表11 OBS桶管理接口

接口

说明

PUT /v1/{project_id}/obs/authority

OBS桶授权及取消授权

数据统计分析接口

表12 数据统计分析接口

接口

说明

GET /v2/{project_id}/stats/bandwidth/detail

查询播放带宽趋势

GET /v2/{project_id}/stats/traffic/detail

查询播放流量趋势

GET /v2/{project_id}/stats/bandwidth/peak

查询播放带宽峰值

GET /v2/{project_id}/stats/traffic/summary

查询播放流量汇总

GET /v2/{project_id}/stats/user

查询观众趋势

GET /v2/{project_id}/stats/httpcodes

查询直播拉流HTTP状态码

GET /v2/{project_id}/stats/transcode

查询转码用量

GET /v2/{project_id}/stats/record

查询录制用量

GET /v2/{project_id}/stats/snapshot

查询截图用量

GET /v2/{project_id}/stats/up-bandwidth/detail

查询上行带宽数据

GET /v2/{project_id}/stats/stream-count

查询域名维度推流路数

GET /v2/{project_id}/stats/history/streams

查询历史推流列表

GET /v2/{project_id}/stats/stream-portraits

查询播放画像信息

GET /v2/{project_id}/stats/area/detail

查询直播各区域指标分布

流监控接口

表13 流监控接口

接口

说明

GET /v2/{project_id}/stats/stream/framerate

查询推流帧率数据

GET /v2/{project_id}/stats/stream/bitrate

查询推流码率数据

GET /v2/{project_id}/stats/stream-detail

查询推流监控数据

GET /v2/{project_id}/stats/up-stream/detail

查询CDN上行推流质量数据

流管理历史接口

表14 流管理历史接口

接口

说明

GET /v1/{project_id}/stream/bandwidth

查询直播加速的带宽数据

GET /v1/{project_id}/stream/traffic

查询直播加速的流量数据

GET /v1/{project_id}/stream/users

查询直播播放在线人数

录制至VOD接口

表15 录制至VOD接口

接口

说明

POST /v1/{project_id}/record/config

创建录制配置

DELETE /v1/{project_id}/record/config

删除录制配置

GET /v1/{project_id}/record/config

查询录制配置

分享:

    相关文档

    相关产品