导航
API 列表
最近更新时间：2025.10.13 12:08:52首次发布时间：2023.09.25 14:30:28
文档反馈
问问助手本文为您介绍了视频直播服务的所有 API，推荐您使用服务端 SDK 来调用 API。
域名管理
| API | 说明 |
|---|---|
| CreateDomain | 添加域名 |
| CreateDomainV2 | 批量添加域名 |
| UpdateDomainVhost | 更新域名的域名空间 |
| DeleteDomain | 删除域名 |
| DisableDomain | 禁用域名 |
| EnableDomain | 启用域名 |
| DescribeDomain | 查询域名信息 |
| ListDomainDetail | 查询域名列表 |
证书管理
| API | 说明 |
|---|---|
| CreateCert | 添加或更新证书 |
| DeleteCert | 删除证书 |
| BindCert | 绑定证书 |
| UnbindCert | 解绑证书 |
| DescribeCertDetailSecretV2 | 查看证书详情 |
| ListCertV2 | 查询证书列表 |
加密管理
| API | 说明 |
|---|---|
| UpdateEncryptDRM | 更新 DRM 证书管理平台访问密钥和 FairPlay 证书 |
| DescribeEncryptDRM | 查看 DRM 证书管理平台访问密钥和 FairPlay 证书 |
| BindEncryptDRM | 添加或更新加密配置 |
| ListBindEncryptDRM | 查询加密配置 |
| UnBindEncryptDRM | 删除加密配置 |
| DescribeLicenseDRM | 获取 DRM 授权许可文件 |
| DescribeCertDRM | 获取 FairPlay 证书文件 |
| UpdateEncryptHLS | 更新 HLS 密钥获取配置 |
| DescribeEncryptHLS | 查询 HLS 密钥获取配置 |
| GetHLSEncryptDataKey | 查询 HLS 加密密钥 |
Header 配置
| API | 说明 |
|---|---|
| UpdateHTTPHeaderConfig | 添加或更新 HTTP header 配置 |
| DescribeHTTPHeaderConfig | 查询 HTTP Header 配置 |
| EnableHTTPHeaderConfig | 启用或禁用 HTTP Header 配置 |
| DeleteHTTPHeaderConfig | 删除 HTTP Header 配置 |
安全管理
| API | 说明 |
|---|---|
| UpdateAuthKey | 添加或更新推拉流鉴权 |
| DescribeAuth | 查询推拉流鉴权 |
| UpdateReferer | 添加或更新 Referer 黑白名单 |
| DescribeReferer | 查询 Referer 黑白名单 |
| DeleteReferer | 删除 Referer 黑白名单 |
| UpdateIPAccessRule | 创建或更新 IP 访问限制 |
| DescribeIPAccessRule | 查询 IP 访问限制 |
| DeleteIPAccessRule | 删除 IP 访问限制 |
限额管理
| API | 说明 |
|---|---|
| UpdateStreamQuotaConfig | 添加或更新推拉流限额配置 |
| DescribeStreamQuotaConfig | 查询推拉流限额配置 |
| DeleteStreamQuotaConfig | 删除推拉流限额配置 |
直播地址
| API | 说明 |
|---|---|
| GeneratePushURL | 生成推流地址 |
| GeneratePlayURL | 生成拉流地址 |
流管理
| API | 说明 |
|---|---|
| DescribeLiveStreamInfoByPage | 查询在线流列表 |
| DescribeClosedStreamInfoByPage | 查询历史流列表 |
| DescribeForbiddenStreamInfoByPage | 查询禁推流列表 |
| KillStream | 断开直播流 |
| ForbidStream | 禁推直播流 |
| ResumeStream | 解禁直播流 |
| DescribeLiveStreamState | 查询流状态 |
转码配置
| API | 说明 |
|---|---|
| CreateTranscodePreset | 添加转码配置 |
| DeleteTranscodePreset | 删除转码配置 |
| UpdateTranscodePreset | 更新转码配置 |
| ListCommonTransPresetDetail | 查询内置转码档位的详细配置 |
| ListVhostTransCodePreset | 查询转码配置列表 |
| TranscodingJobStatus | 查询转码任务 |
| RestartTranscodingJob | 重启转码任务 |
录制配置
| API | 说明 |
|---|---|
| CreateRecordPresetV2 | 添加录制配置 |
| DeleteRecordPreset | 删除录制配置 |
| UpdateRecordPresetV2 | 更新录制配置 |
| ListVhostRecordPresetV2 | 查询录制配置列表 |
| CreatePullRecordTask | 创建直播录制任务 |
| StopPullRecordTask | 停止直播录制任务 |
| ListPullRecordTask | 查询直播录制任务 |
| DescribeRecordTaskFileHistory | 查询录制历史详情 |
| GetPullRecordTask | 查询单个直播录制任务 |
| CreateLiveStreamRecordIndexFiles | 创建录制索引文件 |
截图配置
| API | 说明 |
|---|---|
| CreateSnapshotPresetV2 | 添加截图配置 |
| UpdateSnapshotPresetV2 | 更新截图配置 |
| ListVhostSnapshotPresetV2 | 查询截图配置列表 |
| DeleteSnapshotPreset | 删除截图配置 |
| 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 | 查询水印配置列表 |
| CreateWatermarkPresetV2 | 添加水印模板 |
| UpdateWatermarkPresetV2 | 更新水印模板 |
| DeleteWatermarkPresetV2 | 删除水印模板 |
| ListWatermarkPresetDetail | 查询水印模版列表 |
字幕配置
| API | 说明 |
|---|---|
| CreateSubtitleTranscodePreset | 添加字幕配置 |
| ListVhostSubtitleTranscodePreset | 查询字幕配置列表 |
| UpdateSubtitleTranscodePreset | 更新字幕配置 |
| DeleteSubtitleTranscodePreset | 删除字幕配置 |
拉流转推
| API | 说明 |
|---|---|
| CreatePullToPushTask | 创建拉流转推任务 |
| DeletePullToPushTask | 删除拉流转推任务 |
| UpdatePullToPushTask | 更新拉流转推任务 |
| StopPullToPushTask | 停用拉流转推任务 |
| ListPullToPushTaskV2 | 获取拉流转推任务列表 |
| CreatePullToPushGroup | 创建拉流转推群组 |
| UpdatePullToPushGroup | 更新拉流转推群组 |
| DeletePullToPushGroup | 删除拉流转推群组 |
| ListPullToPushGroup | 查询拉流转推群组列表 |
| ContinuePullToPushTask | 启用拉流转推任务 |
| RelaunchPullToPushTask | 重启拉流转推任务 |
直播垫片
| API | 说明 |
|---|---|
| CreateLivePadPreset | 创建直播垫片配置 |
| DescribeLivePadPresetDetail | 查询直播垫片配置列表 |
| UpdateLivePadPreset | 更新直播垫片配置 |
| DeleteLivePadPreset | 删除直播垫片配置 |
| DescribeLivePadStreamList | 查询正在播放垫片的直播流 |
| StopLivePadStream | 断开正在播放垫片的直播流 |
画质测评
| API | 说明 |
|---|---|
| CreateLiveVideoQualityAnalysisTask | 创建画质评测任务 |
| ListLiveVideoQualityAnalysisTasks | 查询画质评测任务列表 |
| GetLiveVideoQualityAnalysisTaskDetail | 查询单个画质测评任务详情 |
| DeleteLiveVideoQualityAnalysisTask | 删除画质测评任务 |
云端混流
| API | 说明 |
|---|---|
| CreateCloudMixTask | 创建云端混流任务 |
| DeleteCloudMixTask | 结束云端混流任务 |
| UpdateCloudMixTask | 更新云端混流任务 |
| ListCloudMixTask | 查看云端混流任务列表 |
| GetCloudMixTaskDetail | 查看云端混流任务 |
高光智剪
| API | 说明 |
|---|---|
| CreateHighLightTask | 创建高光剪辑任务 |
| DeleteTaskByAccountID | 删除高光剪辑任务 |
| DescribeHighLightTaskByAccountID | 查询高光剪辑任务详情 |
| ListHighLightTask | 查询高光剪辑任务列表 |
通用轮播
| API | 说明 |
|---|---|
| CreateCarouselTask | 创建轮播任务 |
| DeleteCarouselTask | 删除轮播任务 |
| UpdateCarouselTask | 更新轮播任务 |
| GetCarouselDetail | 查询轮播任务 |
| ListCarouselTask | 查询轮播任务列表 |
用量查询
| API | 说明 |
|---|---|
| DescribeLiveBandwidthData | 查询直播域名带宽用量 |
| DescribeLiveTrafficData | 查询直播域名流量用量 |
| DescribeLiveRecordData | 查询直播域名录制用量 |
| DescribeLiveTranscodeData | 查询直播域名转码用量 |
| DescribeLiveSnapshotData | 查询直播域名截图张数 |
| DescribeLiveAuditData | 查询截图审核用量 |
| DescribeLivePullToPushData | 查询拉流转推时长用量 |
| DescribeLiveTimeShiftData | 查询直播时移存储用量 |
| DescribeLiveP95PeakBandwidthData | 查询 95 带宽峰值 |
| DescribeLivePullToPushBandwidthData | 查询拉流转推带宽用量 |
日志管理
| API | 说明 |
|---|---|
| DescribeLiveLogData | 查询日志文件信息 |
统计分析
| API | 说明 |
|---|---|
| DescribeLiveRegionData | 查询区域标识符 |
| DescribeLiveISPData | 查询运营商标识符 |
| DescribeLivePushStreamMetrics | 查询单路推流监控数据 |
| DescribeLiveBatchPushStreamMetrics | 查询多路推流监控数据 |
| DescribeLiveSourceStreamMetrics | 查询单路回源流监控数据 |
| DescribeLiveBatchSourceStreamMetrics | 查询多路回源流监控数据 |
| DescribeLiveStreamSessionData | 查询域名或单个直播流的拉流数据 |
| DescribeLiveBatchStreamTrafficData | 查询直播流的流量数据 |
| DescribeLiveSourceTrafficData | 查询直播流或域名的回源流量监控数据 |
| DescribeLiveBatchStreamTranscodeData | 查询直播流的转码数据 |
| DescribeLivePlayStatusCodeData | 查询域名状态码占比 |
| DescribeIpInfo | 查询 IP 地址归属的 CDN 节点 |
| DescribeLiveStreamCountData | 查询峰值流数 |
| DescribeLivePushStreamInfoData | 查询推流流信息 |
| DescribeLiveTranscodeInfoData | 查询直播域名转码数据明细 |
| DescribeLiveTopPlayData | 查询 TOPN 直播流或域名的流量和带宽信息 |
| DescribeLiveEdgeStatData | 查询边缘数据 |
回调管理
| API | 说明 |
|---|---|
| UpdateCallback | 添加或更新回调配置 |
| DeleteCallback | 删除回调配置 |
| DescribeCallback | 查询回调配置 |
| DescribeLiveCallbackData | 查询回调记录 |