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

API 概览

最近更新时间2023.09.11 20:13:05

首次发布时间2021.11.30 18:32:33

本文为您介绍了视频直播服务的所有 API,推荐您使用服务端 SDK 来调用 API。

域名管理

API说明
CreateDomain添加域名
DeleteDomain刪除域名
DisableDomain禁用域名
EnableDomain启用域名
ManagerPullPushDomainBind修改推拉流域名绑定关系
DescribeDomain查询域名信息
ListDomainDetail查询域名列表

证书管理

API说明
CreateCert添加证书
DeleteCert删除证书
BindCert绑定证书
UnbindCert解绑证书
DescribeCertDetailSceretV2查看证书详情
ListCertV2查询证书列表

安全管理

API说明
UpdateAuthKey添加或更新推拉流鉴权
DescribeAuth查询推拉流鉴权
UpdateDenyConfig添加或更新 IP 黑白名单
DescribeDenyConfig查询 IP 黑白名单
UpdateReferer添加或更新 Referer 黑白名单
DescribeReferer查询 Referer 黑白名单
DeleteReferer删除 Referer 黑白名单

限额管理

API说明
UpdateStreamQuotaConfig添加或更新推拉流限额配置
DescribeStreamQuotaConfig查询推拉流限流配置
DeleteStreamQuotaConfig删除推拉流限额配置

直播地址

API说明
GeneratePushURL生成推流地址
GeneratePlayURL生成拉流地址

流管理

API说明
DescribeLiveStreamInfoByPage查询在线流列表
DescribeClosedStreamInfoByPage查询历史流列表
DescribeForbiddenStreamInfoByPage查询禁推流列表
KillStream断开直播流
ForbidStream禁推直播流
ResumeStream解禁直播流
DescribeLiveStreamState查询流状态

转码配置

API说明
CreateTranscodePreset添加转码配置
DeleteTranscodePreset删除转码配置
UpdateTranscodePreset更新转码配置
ListCommonTransPresetDetail查询内置转码档位的详细配置
ListVhostTransCodePreset查询转码配置列表

录制配置

API说明
CreateRecordPresetV2添加录制配置
DeleteRecordPreset删除录制配置
UpdateRecordPresetV2更新录制配置
ListVhostRecordPresetV2查询录制配置列表
DescribeRecordTaskFileHistory查询录制历史详情

截图配置

API说明
CreateSnapshotPreset添加截图配置
DeleteSnapshotPreset删除截图配置
UpdateSnapshotPreset更新截图配置
ListVhostSnapshotPreset查询截图配置列表
DescribeCDNSnapshotHistory查询截图历史详情

截图审核

API说明
CreateSnapshotAuditPreset添加截图审核配置
DeleteSnapshotAuditPreset删除截图审核配置
UpdateSnapshotAuditPreset更新截图审核配置
ListVhostSnapshotAuditPreset查询截图审核配置列表

拉流回源

API说明
UpdateRelaySourceV3添加或更新播放触发回源配置
DeleteRelaySourceV3删除播放触发回源配置
DescribeRelaySourceV3查询播放触发回源配置
CreateRelaySourceV4添加固定回源配置
DeleteRelaySourceV4删除固定回源配置
UpdateRelaySourceV4更新固定回源配置
ListRelaySourceV4查询固定回源配置列表

直播时移

API说明
CreateTimeShiftPresetV3添加直播时移配置
DeleteTimeShiftPresetV3删除直播时移配置
UpdateTimeShiftPresetV3更新直播时移配置
ListTimeShiftPresetV2查询直播时移配置列表

直播水印

API说明
CreateWatermarkPreset添加水印
DeleteWatermarkPreset删除水印
UpdateWatermarkPreset更新水印
ListWatermarkPreset查询水印
ListVhostWatermarkPreset查询水印列表

拉流转推

API说明
CreatePullToPushTask创建拉流转推任务
DeletePullToPushTask删除拉流转推任务
UpdatePullToPushTask更新拉流转推任务
RestartPullToPushTask启用拉流转推任务
StopPullToPushTask停用拉流转推任务
ListPullToPushTask获取拉流转推任务列表

用量查询

API说明
DescribeLiveBandwidthData查询直播域名带宽用量
DescribeLiveTrafficData查询直播域名流量用量
DescribeRecordData查询直播域名录制用量
DescribeTranscodeData查询直播域名转码用量
DescribeSnapshotData查询直播域名截图张数
DescribeLiveAuditData查询截图审核用量
DescribePullToPushData查询拉流转推时长用量
DescribeLiveTimeShiftData查询直播时移存储用量
DescribeLiveP95PeakBandwidthData查询 95 带宽峰值
DescribePullToPushBandwidthData查询拉流转推带宽用量

日志管理

API说明
DescribeLiveDomainLog查询日志文件信息
DescribeLivePullToPushLog查询拉流转推日志文件

统计分析

API说明
DescribePushStreamMetrics查询单路推流监控数据
DescribeLiveBatchPushStreamMetrics查询多路推流监控数据
DescribeLiveSourceStreamMetrics查询单路回源流监控数据
DescribeLiveBatchSourceStreamMetrics查询多路回源流监控数据
DescribeLiveStreamSessionData查询直播流历史请求数和在线人数
DescribeLiveMetricTrafficData查询直播流或域名的流量监控数据
DescribeLiveMetricBandwidthData查询直播流或域名的带宽监控数据
DescribeLiveSourceTrafficData查询直播流或域名的回源流量监控数据
DescribeLiveSourceBandwidthData查询直播流或域名的回源带宽监控数据
DescribeLivePlayStatusCodeData查询域名状态码占比
DescribeIpInfo查询 IP 地址归属的 CDN 节点

回调管理

API说明
UpdateCallback添加或更新回调配置
DeleteCallback删除回调配置
DescribeCallback查询回调配置