API概览_API参考_视频直播-阿里云

调用方式


API	描述
请求结构	请求结构
返回结果	调用 API 服务后返回数据采用统一格式：
签名机制	签名机制

域名管理


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

直播拉流


API	描述
AddLivePullStreamInfoConfig	添加直播拉流信息，仅支持拉取直播流。支持rtmp，http，flv格式。
DescribeLivePullStreamConfig	调用DescribeLivePullStreamConfig查询域名下拉流配置信息。
DeleteLivePullStreamInfoConfig	调用DeleteLivePullStreamInfoConfig删除拉流信息。

直播流管理


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

推流回调


API	描述
SetLiveStreamsNotifyUrlConfig	调用SetLiveStreamsNotifyUrlConfig设置推流回调配置。
DescribeLiveStreamsNotifyUrlConfig	调用DescribeLiveStreamsNotifyUrlConfig查询推流回调配置。
DeleteLiveStreamsNotifyUrlConfig	调用DeleteLiveStreamsNotifyUrlConfig删除推流回调配置。
回调格式说明	流状态实时信息回调，可以及时通知用户推流或断流操作结果。

直播时移


API	描述
直播时移	直播时移

直播转码


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

直播转点播


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

直播录制


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

直播截图


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

直播审核


API	描述
DescribeLiveSnapshotDetectPornConfig	调用DescribeLiveSnapshotDetectPornConfig查询审核配置。
AddLiveSnapshotDetectPornConfig	调用AddLiveSnapshotDetectPornConfig可按照域名和App级别配置直播流审核服务。
AddLiveDetectNotifyConfig	调用AddLiveDetectNotifyConfig添加回调通知URL。
DescribeLiveDetectNotifyConfig	调用DescribeLiveDetectNotifyConfig查询回调通知URL。
UpdateLiveSnapshotDetectPornConfig	调用UpdateLiveSnapshotDetectPornConfig更新审核配置。
UpdateLiveDetectNotifyConfig	调用UpdateLiveDetectNotifyConfig更新回调通知URL。
DeleteLiveSnapshotDetectPornConfig	调用DeleteLiveSnapshotDetectPornConfig删除直播审核的配置。
DeleteLiveDetectNotifyConfig	调用DeleteLiveDetectNotifyConfig删除回调通知URL。

资源监控


API	描述
DescribeLiveDomainBpsData	调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。
DescribeLiveDomainRecordData	调用DescribeLiveDomainRecordData查询直播域名录制时长数据。
DescribeLiveDomainSnapshotData	调用DescribeLiveDomainSnapshotData查询直播域名截图张数数据。
DescribeLiveDomainTrafficData	调用DescribeLiveDomainTrafficData查询直播域名网络流量监控数据。
DescribeLiveDomainTranscodeData	调用DescribeLiveDomainTranscodeData查询直播域名转码时长数据。
DescribeLiveStreamOnlineUserNum	调用DescribeLiveStreamOnlineUserNum查询直播流实时在线人数。
DescribeLiveDomainRealTimeBpsData	调用DescribeLiveDomainRealTimeBpsData获取域名1分钟粒度带宽数据。
DescribeLiveDomainRealTimeHttpCodeData	调用DescribeLiveDomainRealTimeHttpCodeData获取加速域名1分钟粒度的HTTP返回码占比数据。
DescribeLiveDomainRealTimeTrafficData	调用DescribeLiveDomainRealTimeTrafficData获取加速域名的1分钟流量监控数据。
DescribeLiveStreamHistoryUserNum	调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。

导播服务API


API	描述
CreateCaster	调用CreateCaster创建导播台。
AddCasterLayout	调用AddCasterLayout添加导播台布局。
AddCasterVideoResource	调用AddCasterVideoResource添加视频源，视频源数量受限于导播台输入路数。
AddCasterEpisode	调用AddCasterEpisode添加导播台节目。
AddCasterComponent	调用AddCasterComponent添加组件。
AddCasterProgram	调用AddCasterProgram添加导播台节目单。
AddCasterEpisodeGroup	调用AddCasterEpisodeGroup添加导播台节目列表。
AddCasterEpisodeGroupContent	调用AddCasterEpisodeGroupContent添加导播台节目列表。
CopyCaster	调用CopyCaster复制导播台，复制指定导播台并返回新导播台实例。
CopyCasterSceneConfig	调用CopyCasterSceneConfig将原场景配置应用至目标场景并生效，仅限PVW场景配置拷贝至PGM场景。
DeleteCaster	调用DeleteCaster删除导播台。
DeleteCasterLayout	调用DeleteCasterLayout删除布局数据。
DeleteCasterVideoResource	调用DeleteCasterVideoResource删除视频资源。
DeleteCasterEpisode	调用DeleteCasterEpisode删除导播台节目。
DeleteCasterProgram	调用DeleteCasterProgram删除导播台节目单。
DeleteCasterEpisodeGroup	调用DeleteCasterEpisodeGroup删除导播台节目列表。
DeleteCasterComponent	调用DeleteCasterComponent删除组件。
DeleteCasterSceneConfig	调用DeleteCasterSceneConfig清除指定场景的配置信息。
DescribeCasterConfig	调用DescribeCasterConfig查询导播台配置信息。
DescribeCasterLayouts	调用DescribeCasterLayouts查询布局列表。
DescribeCasters	调用DescribeCasters查询导播台列表。
DescribeCasterScenes	调用DescribeCasterScenes查询场景信息列表。
DescribeCasterStreamUrl	调用DescribeCasterStreamUrl查询导播台流信息列表。
DescribeCasterVideoResources	调用DescribeCasterVideoResources查询视频源。
DescribeCasterProgram	调用DescribeCasterProgram查询导播台节目单。
DescribeCasterComponents	调用DescribeCasterComponents查询导播台组件列表。
DescribeCasterSceneAudio	调用DescribeCasterSceneAudio查询场景音频配置信息。
DescribeCasterChannels	调用DescribeCasterChannels查询导播台通道信息列表。
EffectCasterUrgent	调用EffectCasterUrgent将指定场景画面紧急切换至备播视频，限制仅用于PGM场景的备播切换。
EffectCasterVideoResource	调用EffectCasterVideoResource将视频资源生效至指定场景，场景引用该视频资源时有效。
ModifyCasterLayout	调用ModifyCasterLayout修改布局配置，传递修改项，非修改内容无需传递。
ModifyCasterComponent	调用ModifyCasterComponent修改组件。
ModifyCasterVideoResource	调用ModifyCasterVideoResource修改视频资源。
ModifyCasterEpisode	调用ModifyCasterEpisode修改导播台节目配置,节目类型不允许修改。
ModifyCasterProgram	调用ModifyCasterProgram修改导播台节目单。
SetCasterConfig	调用SetCasterConfig配置导播台，全量覆盖配置信息，若指定参数置为空则清除导播台该项配置。
SetCasterSceneConfig	调用SetCasterSceneConfig全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。
SetCasterChannel	调用SetCasterChannel在视频源同步模式时，将视频资源设置到通道中。
StartCaster	调用StartCaster启动导播台。若PVW、PGM场景不存在则创建，启动PVW、PGM场景，启动底层音视频处理任务。
StartCasterScene	调用StartCasterScene启动指定场景，限制仅用于PVW的打开。
StopCaster	调用StopCaster停止导播台，停止PVW、PGM场景，清理输出配置，停止底层音视频处理任务。
StopCasterScene	调用StopCasterScene停止指定场景，限制仅用于PVW的关闭。
UpdateCasterSceneConfig	调用UpdateCasterSceneConfig增量设置场景配置，不清空原配置，布局信息在原场景上增量修改，效率较全量设置高。
UpdateCasterSceneAudio	调用UpdateCasterSceneAudio更新场景音频配置。