API概览

阿里云视频直播的OpenAPI采用RPC签名风格，签名细节参见RPC 调用机制。本文为您介绍了视频直播服务的所有API列表，建议您使用服务端SDK来调用API。

域名管理

API	描述
AddLiveDomain	调用AddLiveDomain添加直播域名，一次只能提交一个域名。
AddLiveDomainPlayMapping	调用AddLiveDomainPlayMapping添加主播流域名和子播流域名映射。
DeleteLiveDomainPlayMapping	调用DeleteLiveDomainPlayMapping删除主播流域名和子播流域名的映射关系配置。
AddLiveDomainMapping	调用AddLiveDomainMapping添加播流域名和推流域名的映射关系配置。
DeleteLiveDomain	调用DeleteLiveDomain删除已添加的直播域名。
DeleteLiveDomainMapping	调用DeleteLiveDomainMapping删除播流域名和推流域名的映射关系配置。
DescribeLiveDomainMapping	调用DescribeLiveDomainMapping查询推流域名、主播流域名和子播流域名映射。
DescribeLiveDomainDetail	调用DescribeLiveDomainDetail获取指定直播域名配置的基本信息。
DescribeLiveUserDomains	调用DescribeLiveUserDomains查询用户名下所有的直播域名。
StartLiveDomain	调用StartLiveDomain启用状态为停用的直播域名，将DomainStatus变更为online。
StopLiveDomain	调用StopLiveDomain停用某个直播域名，将DomainStatus变更为offline。
DescribeLiveCertificateDetail	调用DescribeLiveCertificateDetail获取证书详细信息。
DescribeLiveDomainCertificateInfo	调用DescribeLiveDomainCertificateInfo获取指定直播域名证书信息。
DescribeLiveCertificateList	调用DescribeLiveCertificateList获取证书列表信息。
SetLiveDomainCertificate	调用SetLiveDomainCertificate设置某域名下证书功能是否启用及修改证书信息。
BatchDeleteLiveDomainConfigs	调用BatchDeleteLiveDomainConfigs批量删除域名配置。
BatchSetLiveDomainConfigs	调用BatchSetLiveDomainConfigs批量配置域名。
DescribeLiveDomainConfigs	调用DescribeLiveDomainConfigs查询直播域名配置，一次可查询多个功能配置。

直播拉流

API	描述
AddLivePullStreamInfoConfig	调用AddLivePullStreamInfoConfig添加直播拉流配置信息。
DescribeLivePullStreamConfig	调用DescribeLivePullStreamConfig查询域名下拉流配置信息。
DeleteLivePullStreamInfoConfig	调用DeleteLivePullStreamInfoConfig删除拉流信息。
SetLiveLazyPullStreamInfoConfig	调用SetLiveLazyPullStreamInfoConfig添加拉流信息。
DescribeLiveLazyPullStreamConfig	调用DescribeLiveLazyPullStreamConfig查询播流域名下触发拉流配置信息。
DeleteLiveLazyPullStreamInfoConfig	调用DeleteLiveLazyPullStreamInfoConfig删除触发拉流配置信息。
UpdateLivePullStreamInfoConfig	调用UpdateLivePullStreamInfoConfig更新直播拉流配置信息，包括源站地址、开始时间和结束时间。

直播流管理

API	描述
DescribeLiveStreamsBlockList	调用DescribeLiveStreamsBlockList获取域名下播流播放的黑名单。
DescribeLiveStreamsControlHistory	调用DescribeLiveStreamsControlHistory获取某个域名或应用下的直播流操作记录。
DescribeLiveStreamBitRateData	调用DescribeLiveStreamBitRateData查询RTMP协议的直播流的设置时间范围内的一组帧率和码率，适用于获取历史数据。
DescribeLiveStreamsOnlineList	调用DescribeLiveStreamsOnlineList查看指定域名下（或者指定域名下某个应用）的所有正在推的流的信息。
DescribeLiveStreamsPublishList	调用DescribeLiveStreamsPublishList获取某一时间段内某个域名（或域名下某应用或某个流）的推流记录。
ForbidLiveStream	调用ForbidLiveStream禁止某条流的推送，可以预设某个时刻将流恢复。
ResumeLiveStream	调用ResumeLiveStream恢复某条流的推送。
DescribeLiveDomainOnlineUserNum	调用DescribeLiveDomainOnlineUserNum查询域名下所有流某分钟的在线人数信息。
DescribeLiveDomainFrameRateAndBitRateData	调用DescribeLiveDomainFrameRateAndBitRateData查询推流域名下流帧率和码率数据。
DescribeLiveDomainLimit	调用DescribeLiveDomainLimit查询指定播流域名的推流数量限制和转码数量限制。
DescribeLiveStreamState	调用DescribeLiveStreamState实时查询单路流状态。

直播转推

API	描述
DescribeLiveEdgeTransfer	调用DescribeLiveEdgeTransfer查询直播转推配置。
DeleteLiveEdgeTransfer	调用DeleteLiveEdgeTransfer删除直播转推配置。
SetLiveEdgeTransfer	调用SetLiveEdgeTransfer设置直播转推配置。

推流回调

API	描述
SetLiveStreamsNotifyUrlConfig	调用SetLiveStreamsNotifyUrlConfig设置推流回调配置。
DescribeLiveStreamsNotifyUrlConfig	调用DescribeLiveStreamsNotifyUrlConfig查询推流回调配置。
DeleteLiveStreamsNotifyUrlConfig	调用DeleteLiveStreamsNotifyUrlConfig删除推流回调配置。

直播时移

API	描述
DescribeLiveShiftConfigs	调用DescribeLiveShiftConfigs查询指定域名的时移配置。
OpenLiveShift	调用OpenLiveShift为指定域名（应用、直播流）开启时移服务。
CloseLiveShift	调用CloseLiveShift关闭指定域名（应用、直播流）的时移服务。

直播转码

API	描述
AddLiveStreamTranscode	调用AddLiveStreamTranscode添加转码配置信息。
AddCustomLiveStreamTranscode	调用AddCustomLiveStreamTranscode添加自定义转码配置信息。
AddRtsLiveStreamTranscod	调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。
DeleteLiveStreamTranscode	调用DeleteLiveStreamTranscode删除转码配置信息。
DescribeLiveStreamTranscodeInfo	调用DescribeLiveStreamTranscodeInfo查询转码配置信息。
AddTrancodeSEI	调用AddTrancodeSEI添加转码SEI信息。

直播转点播

API	描述
AddLiveRecordVodConfig	调用AddLiveRecordVodConfig增加直播录制转点播配置，将录制内容保存到点播媒资库。
DeleteLiveRecordVodConfig	调用DeleteLiveRecordVodConfig删除直播录制转点播配置。
DescribeLiveRecordVodConfigs	调用DescribeLiveRecordVodConfigs查询直转点配置列表。

直播录制

API	描述
AddLiveAppRecordConfig	调用AddLiveAppRecordConfig配置App录制，输出内容保存到OSS中。
RealTimeRecordCommand	调用RealTimeRecordCommand按需完成手动录制。例如动态启动录制、动态停止录制。
DeleteLiveAppRecordConfig	调用DeleteLiveAppRecordConfig解除录制配置。
DescribeLiveRecordConfig	调用DescribeLiveRecordConfig查询域名下所有App录制配置。
DescribeLiveStreamRecordContent	调用DescribeLiveStreamRecordContent查询录制内容。
CreateLiveStreamRecordIndexFiles	调用CreateLiveStreamRecordIndexFiles创建录制索引文件。
DescribeLiveStreamRecordIndexFile	调用DescribeLiveStreamRecordIndexFile查询单个录制索引文件。
DescribeLiveStreamRecordIndexFiles	调用DescribeLiveStreamRecordIndexFiles查询某个时间段内的所有录制索引文件。
AddLiveRecordNotifyConfig	调用AddLiveRecordNotifyConfig添加域名级别录制回调配置。
DeleteLiveRecordNotifyConfig	调用DeleteLiveRecordNotifyConfig删除域名级别录制回调配置。
DescribeLiveRecordNotifyConfig	调用DescribeLiveRecordNotifyConfig查询域名级别录制回调配置。
UpdateLiveRecordNotifyConfig	调用UpdateLiveRecordNotifyConfig更新域名级别录制回调配置。

直播截图

API	描述
AddLiveAppSnapshotConfig	调用AddLiveAppSnapshotConfig配置截图信息。输出内容保存到OSS中，重新推流即生效。
DeleteLiveAppSnapshotConfig	调用DeleteLiveAppSnapshotConfig解除直播流下AppName的截图配置，重新推流后生效。
DescribeLiveSnapshotConfig	调用DescribeLiveSnapshotConfig查询域名下的截图配置。
UpdateLiveAppSnapshotConfig	调用UpdateLiveAppSnapshotConfig更新直播流下的截图配置。输出内容保存到OSS中，重新推流后生效。
DescribeLiveStreamSnapshotInfo	调用DescribeLiveStreamSnapshotInfo查询一段时间内截图内容。
SetSnapshotCallbackAuth	调用SetSnapshotCallbackAuth设置截图回调鉴权配置。
QuerySnapshotCallbackAuth	调用QuerySnapshotCallbackAuth查询截图回调鉴权配置信息。
DeleteSnapshotCallbackAuth	调用DeleteSnapshotCallbackAuth删除截图回调鉴权配置。

直播审核

API	描述
AddLiveSnapshotDetectPornConfig	调用AddLiveSnapshotDetectPornConfig可按照域名和App级别配置直播流审核服务。
AddLiveDetectNotifyConfig	调用AddLiveDetectNotifyConfig添加回调通知地址。
DescribeLiveSnapshotDetectPornConfig	调用DescribeLiveSnapshotDetectPornConfig查询审核配置。
DescribeLiveDetectNotifyConfig	调用DescribeLiveDetectNotifyConfig查询回调通知地址。
UpdateLiveSnapshotDetectPornConfig	调用UpdateLiveSnapshotDetectPornConfig更新审核配置。
UpdateLiveDetectNotifyConfig	调用UpdateLiveDetectNotifyConfig更新回调通知地址。
DeleteLiveSnapshotDetectPornConfig	调用DeleteLiveSnapshotDetectPornConfig删除直播审核的配置。
DeleteLiveDetectNotifyConfig	调用DeleteLiveDetectNotifyConfig删除回调通知地址。
AddLiveAudioAuditConfig	调用AddLiveAudioAuditConfig添加直播语音审核配置。
AddLiveAudioAuditNotifyConfig	调用AddLiveAudioAuditNotifyConfig添加音频审核回调信息。
DeleteLiveAudioAuditConfig	调用DeleteLiveAudioAuditConfig删除直播语音审核配置。
DeleteLiveAudioAuditNotifyConfig	调用DeleteLiveAudioAuditNotifyConfig删除直播语音审核回调配置。
UpdateLiveAudioAuditNotifyConfig	调用UpdateLiveAudioAuditNotifyConfig更新音频审核回调信息。
UpdateLiveAudioAuditConfig	调用UpdateLiveAudioAuditConfig更新直播语音审核配置。
DescribeLiveAudioAuditConfig	调用DescribeLiveAudioAuditConfig查询直播语音审核配置
DescribeLiveAudioAuditNotifyConfig	调用DescribeLiveAudioAuditNotifyConfig直播语音审核回调配置查询。

监控统计

API	描述
DescribeLiveDomainBpsData	调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。
DescribeLiveDomainTrafficData	调用DescribeLiveDomainTrafficData查询直播域名网络流量监控数据。
DescribeLiveDomainPushBpsData	调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。
DescribeLiveDomainPushTrafficData	调用DescribeLiveDomainPushTrafficData获取推流域名的推流流量监控数据。
DescribeLiveDomainRealTimeBpsData	调用DescribeLiveDomainRealTimeBpsData查询直播域名实时带宽数据。
DescribeLiveDomainRealTimeTrafficData	调用DescribeLiveDomainRealTimeTrafficData获取加速域名的1分钟流量监控数据。
DescribeLiveStreamHistoryUserNum	调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。
DescribeLiveDomainRealTimeHttpCodeData	调用DescribeLiveDomainRealTimeHttpCodeData获取加速域名1分钟粒度的HTTP返回码占比数据。
DescribeLiveStreamCount	调用DescribeLiveStreamCount获取直播流的实时在线原始流和转码流流数信息。
DescribeLiveDomainPvUvData	调用DescribeLiveDomainPvUvData查询指定直播域名的PV、UV数据。

用量查询

API	描述
DescribeLiveDomainRecordUsageData	调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。
DescribeLiveDomainSnapshotData	调用DescribeLiveDomainSnapshotData查询直播域名截图张数数据。
DescribeLiveDetectPornData	调用DescribeLiveDetectPornData获取查询直播审核用量数据。
DescribeDomainUsageData	调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。
DescribeLiveRealtimeDeliveryAcc	调用DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数。
DescribeLiveDomainTimeShiftData	调用DescribeLiveDomainTimeShiftData查询直播时移用量数据。
DescribeLiveDomainStreamTranscodeData	调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。

云导播

云导播接口概览及分组，请参见API概览。

云端合流

API	描述
CreateMixStream	调用CreateMixStream创建合流任务，开始合流。
UpdateMixStream	调用UpdateMixStream更新合流任务。
DescribeMixStreamList	调用DescribeMixStreamList查询合流任务列表。
DeleteMixStream	调用DeleteMixStream删除合流任务。
CreateCustomTemplate	调用CreateCustomTemplate创建合流自定义模板。
DeleteCustomTemplate	调用DeleteCustomTemplate删除合流自定义模板。
GetCustomTemplate	调用GetCustomTemplate获取合流自定义模板。
GetAllCustomTemplates	调用GetAllCustomTemplates获取全量自定义合流模板。

直播水印

API	描述
AddLiveStreamWatermark	调用AddLiveStreamWatermark添加水印模板。
DeleteLiveStreamWatermark	调用DeleteLiveStreamWatermark删除指定⽔印模板。
UpdateLiveStreamWatermark	调用UpdateLiveStreamWatermark更新水印模板。
DescribeLiveStreamWatermark	调用DescribeLiveStreamWatermarks查询水印模板列表。
AddLiveStreamWatermarkRule	调用AddLiveStreamWatermarkRule添加水印规则。
DeleteLiveStreamWatermarkRule	调用DeleteLiveStreamWatermarkRule删除水印规则。
UpdateLiveStreamWatermarkRule	调用UpdateLiveStreamWatermarkRule更新水印规则。
DescribeLiveStreamWatermarkRule	调用DescribeLiveStreamWatermarkRules查询水印规则列表。

直播日志

API	描述
EnableLiveRealtimeLogDelivery	调用EnableLiveRealtimeLogDelivery开启域名实时日志投递。
DisableLiveRealtimeLogDelivery	调用DisableLiveRealtimeLogDelivery暂停域名实时日志投递。
ModifyLiveRealtimeLogDelivery	调用ModifyLiveRealtimeLogDelivery更改域名实时日志投递。
CreateLiveRealTimeLogDelivery	调用CreateLiveRealTimeLogDelivery创建域名实时日志投递。
DeleteLiveRealtimeLogDelivery	调用DeleteLiveRealtimeLogDelivery删除域名实时日志推送。
DescribeLiveDomainRealtimeLogDelivery	调用DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息。
ListLiveRealtimeLogDelivery	调用ListLiveRealtimeLogDelivery查询用户下所有实时日志投递。
ListLiveRealtimeLogDeliveryDomains	调用ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有有直播域名。
ListLiveRealtimeLogDeliveryInfo	调用ListLiveRealtimeLogDeliveryInfo查询所有实时日志投递服务信息。
DeleteLiveRealTimeLogLogstore	调用DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore。
DescribeLiveDomainLog	调用DescribeLiveDomainLog查询视频直播指定域名的离线日志信息。

直播监播

API	描述
CreateLiveStreamMonitor	调用CreateLiveStreamMonitor创建监播室。
UpdateLiveStreamMonitor	调用UpdateLiveStreamMonitor更新监播室配置。
DescribeLiveStreamMonitor	调用DescribeLiveStreamMonitorList查询已创建的监播室列表。
StartLiveStreamMonitor	调用StartLiveStreamMonitor开启监播。
StopLiveStreamMonitor	调用StopLiveStreamMonitor停止监播。
DeleteLiveStreamMonitor	调用DeleteLiveStreamMonitor删除监播室。

阿里云首页视频直播相关技术圈