API概览
阿里云视频直播的OpenAPI采用RPC签名风格，签名细节参见RPC 调用机制。本文为您介绍了视频直播服务的所有API列表，建议您使用服务端SDK来调用API。
域名管理
API | 描述 |
调用AddLiveDomain添加直播域名，一次只能提交一个域名。 | |
调用AddLiveDomainPlayMapping添加主播流域名和子播流域名映射。 | |
调用DeleteLiveDomainPlayMapping删除主播流域名和子播流域名的映射关系配置。 | |
调用AddLiveDomainMapping添加播流域名和推流域名的映射关系配置。 | |
调用DeleteLiveDomain删除已添加的直播域名。 | |
调用DeleteLiveDomainMapping删除播流域名和推流域名的映射关系配置。 | |
调用DescribeLiveDomainMapping查询推流域名、主播流域名和子播流域名映射。 | |
调用DescribeLiveDomainDetail获取指定直播域名配置的基本信息。 | |
调用DescribeLiveUserDomains查询用户名下所有的直播域名。 | |
调用StartLiveDomain启用状态为停用的直播域名，将DomainStatus变更为online。 | |
调用StopLiveDomain停用某个直播域名，将DomainStatus变更为offline。 | |
调用DescribeLiveCertificateDetail获取证书详细信息。 | |
调用DescribeLiveDomainCertificateInfo获取指定直播域名证书信息。 | |
调用DescribeLiveCertificateList获取证书列表信息。 | |
调用SetLiveDomainCertificate设置某域名下证书功能是否启用及修改证书信息。 | |
调用BatchDeleteLiveDomainConfigs批量删除域名配置。 | |
调用BatchSetLiveDomainConfigs批量配置域名。 | |
调用DescribeLiveDomainConfigs查询直播域名配置，一次可查询多个功能配置。 |
直播拉流
API | 描述 |
调用AddLivePullStreamInfoConfig添加直播拉流配置信息。 | |
调用DescribeLivePullStreamConfig查询域名下拉流配置信息。 | |
调用DeleteLivePullStreamInfoConfig删除拉流信息。 | |
调用SetLiveLazyPullStreamInfoConfig添加拉流信息。 | |
调用DescribeLiveLazyPullStreamConfig查询播流域名下触发拉流配置信息。 | |
调用DeleteLiveLazyPullStreamInfoConfig删除触发拉流配置信息。 | |
调用UpdateLivePullStreamInfoConfig更新直播拉流配置信息，包括源站地址、开始时间和结束时间。 |
直播流管理
API | 描述 |
调用DescribeLiveStreamsBlockList获取域名下播流播放的黑名单。 | |
调用DescribeLiveStreamsControlHistory获取某个域名或应用下的直播流操作记录。 | |
调用DescribeLiveStreamBitRateData查询RTMP协议的直播流的设置时间范围内的一组帧率和码率，适用于获取历史数据。 | |
调用DescribeLiveStreamsOnlineList查看指定域名下（或者指定域名下某个应用）的所有正在推的流的信息。 | |
调用DescribeLiveStreamsPublishList获取某一时间段内某个域名（或域名下某应用或某个流）的推流记录。 | |
调用ForbidLiveStream禁止某条流的推送，可以预设某个时刻将流恢复。 | |
调用ResumeLiveStream恢复某条流的推送。 | |
调用DescribeLiveDomainOnlineUserNum查询域名下所有流某分钟的在线人数信息。 | |
调用DescribeLiveDomainFrameRateAndBitRateData查询推流域名下流帧率和码率数据。 | |
调用DescribeLiveDomainLimit查询指定播流域名的推流数量限制和转码数量限制。 | |
调用DescribeLiveStreamState实时查询单路流状态。 |
边缘转推
API | 描述 |
调用DescribeLiveEdgeTransfer查询直播转推配置。 | |
调用DeleteLiveEdgeTransfer删除直播转推配置。 | |
调用SetLiveEdgeTransfer设置直播转推配置。 |
中心转推
API | 描述 |
调用AddLiveCenterTransfer添加直播中心转推配置。 | |
调用UpdateLiveCenterTransfer修改直播中心转推配置。 | |
调用DescribeLiveCenterTransfer查询直播中心转推配置。 | |
调用DeleteLiveCenterTransfer删除直播中心转推配置。 |
推流回调
API | 描述 |
调用SetLiveStreamsNotifyUrlConfig设置推流回调配置。 | |
调用DescribeLiveStreamsNotifyUrlConfig查询推流回调配置。 | |
调用DeleteLiveStreamsNotifyUrlConfig删除推流回调配置。 |
直播时移
API | 描述 |
调用DescribeLiveShiftConfigs查询指定域名的时移配置。 | |
调用OpenLiveShift为指定域名（应用、直播流）开启时移服务。 | |
调用CloseLiveShift关闭指定域名（应用、直播流）的时移服务。 |
直播转码
API | 描述 |
调用AddLiveStreamTranscode添加转码配置信息。 | |
调用AddCustomLiveStreamTranscode添加自定义转码配置信息。 | |
调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。 | |
调用DeleteLiveStreamTranscode删除转码配置信息。 | |
调用DescribeLiveStreamTranscodeInfo查询转码配置信息。 | |
调用AddTrancodeSEI添加转码SEI信息。 |
直播转点播
API | 描述 |
调用AddLiveRecordVodConfig增加直播录制转点播配置，将录制内容保存到点播媒资库。 | |
调用DeleteLiveRecordVodConfig删除直播录制转点播配置。 | |
调用DescribeLiveRecordVodConfigs查询直转点配置列表。 |
直播录制
API | 描述 |
调用AddLiveAppRecordConfig配置App录制，输出内容保存到OSS中。 | |
调用RealTimeRecordCommand按需完成手动录制。例如动态启动录制、动态停止录制。 | |
调用DeleteLiveAppRecordConfig解除录制配置。 | |
调用DescribeLiveRecordConfig查询域名下所有App录制配置。 | |
调用DescribeLiveStreamRecordContent查询录制内容。 | |
调用CreateLiveStreamRecordIndexFiles创建录制索引文件。 | |
调用DescribeLiveStreamRecordIndexFile查询单个录制索引文件。 | |
调用DescribeLiveStreamRecordIndexFiles查询某个时间段内的所有录制索引文件。 | |
调用AddLiveRecordNotifyConfig添加域名级别录制回调配置。 | |
调用DeleteLiveRecordNotifyConfig删除域名级别录制回调配置。 | |
调用DescribeLiveRecordNotifyConfig查询域名级别录制回调配置。 | |
调用UpdateLiveRecordNotifyConfig更新域名级别录制回调配置。 |
直播截图
API | 描述 |
调用AddLiveAppSnapshotConfig配置截图信息。输出内容保存到OSS中，重新推流即生效。 | |
调用DeleteLiveAppSnapshotConfig解除直播流下AppName的截图配置，重新推流后生效。 | |
调用DescribeLiveSnapshotConfig查询域名下的截图配置。 | |
调用UpdateLiveAppSnapshotConfig更新直播流下的截图配置。输出内容保存到OSS中，重新推流后生效。 | |
调用DescribeLiveStreamSnapshotInfo查询一段时间内截图内容。 | |
调用SetSnapshotCallbackAuth设置截图回调鉴权配置。 | |
调用QuerySnapshotCallbackAuth查询截图回调鉴权配置信息。 | |
调用DeleteSnapshotCallbackAuth删除截图回调鉴权配置。 |
直播审核
API | 描述 |
调用AddLiveSnapshotDetectPornConfig可按照域名和App级别配置直播流审核服务。 | |
调用AddLiveDetectNotifyConfig添加回调通知地址。 | |
调用DescribeLiveSnapshotDetectPornConfig查询审核配置。 | |
调用DescribeLiveDetectNotifyConfig查询回调通知地址。 | |
调用UpdateLiveSnapshotDetectPornConfig更新审核配置。 | |
调用UpdateLiveDetectNotifyConfig更新回调通知地址。 | |
调用DeleteLiveSnapshotDetectPornConfig删除直播审核的配置。 | |
调用DeleteLiveDetectNotifyConfig删除回调通知地址。 | |
调用AddLiveAudioAuditConfig添加直播语音审核配置。 | |
调用AddLiveAudioAuditNotifyConfig添加音频审核回调信息。 | |
调用DeleteLiveAudioAuditConfig删除直播语音审核配置。 | |
调用DeleteLiveAudioAuditNotifyConfig删除直播语音审核回调配置。 | |
调用UpdateLiveAudioAuditNotifyConfig更新音频审核回调信息。 | |
调用UpdateLiveAudioAuditConfig更新直播语音审核配置。 | |
调用DescribeLiveAudioAuditConfig查询直播语音审核配置 | |
调用DescribeLiveAudioAuditNotifyConfig直播语音审核回调配置查询。 |
监控统计
API | 描述 |
调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。 | |
调用DescribeLiveDomainTrafficData查询直播域名网络流量监控数据。 | |
调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。 | |
调用DescribeLiveDomainPushTrafficData获取推流域名的推流流量监控数据。 | |
调用DescribeLiveDomainRealTimeBpsData查询直播域名实时带宽数据。 | |
调用DescribeLiveDomainRealTimeTrafficData获取加速域名的1分钟流量监控数据。 | |
调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。 | |
调用DescribeLiveDomainRealTimeHttpCodeData获取加速域名1分钟粒度的HTTP返回码占比数据。 | |
调用DescribeLiveStreamCount获取直播流的实时在线原始流和转码流流数信息。 | |
调用DescribeLiveDomainPvUvData查询指定直播域名的PV、UV数据。 |
用量查询
API | 描述 |
调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。 | |
调用DescribeLiveDomainSnapshotData查询直播域名截图张数数据。 | |
调用DescribeLiveDetectPornData获取查询直播审核用量数据。 | |
调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。 | |
调用DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数。 | |
调用DescribeLiveDomainTimeShiftData查询直播时移用量数据。 | |
调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。 |
云导播
云导播接口概览及分组，请参见API概览。
API | 描述 |
调用CreateCaster创建导播台。 | |
调用AddCasterLayout添加导播台布局。 | |
调用AddCasterVideoResource添加视频源，视频源数量受限于导播台输入路数。 | |
调用CopyCaster复制导播台，复制指定导播台并返回新导播台实例。 | |
调用CopyCasterSceneConfig将原场景配置应用至目标场景并生效，仅限PVW场景配置拷贝至PGM场景。 | |
调用AddCasterComponent添加组件。 | |
调用DeleteCaster删除导播台。 | |
调用DeleteCasterLayout删除布局数据。 | |
调用DeleteCasterVideoResource删除视频资源。 | |
调用DescribeCasterConfig查询导播台配置信息。 | |
调用DescribeCasterLayouts查询布局列表。 | |
调用DescribeCasters查询导播台列表。 | |
调用DescribeCasterScenes查询场景信息列表。 | |
调用DescribeCasterStreamUrl查询导播台流信息列表。 | |
调用DescribeCasterVideoResources查询视频源。 | |
调用EffectCasterUrgent将指定场景画面紧急切换至备播视频，限制仅用于PGM场景的备播切换。 | |
调用EffectCasterVideoResource将视频资源生效至指定场景，场景引用该视频资源时有效。 | |
调用ModifyCasterLayout修改布局配置，传递修改项，非修改内容无需传递。 | |
调用ModifyCasterVideoResource修改视频资源。 | |
调用SetCasterConfig配置导播台，全量覆盖配置信息，若指定参数置为空则清除导播台该项配置。 | |
调用SetCasterSceneConfig全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。 | |
调用StartCaster启动导播台。若PVW、PGM场景不存在则创建，启动PVW、PGM场景，启动底层音视频处理任务。 | |
调用StartCasterScene启动指定场景，限制仅用于PVW的打开。 | |
调用StopCaster停止导播台，停止PVW、PGM场景，清理输出配置，停止底层音视频处理任务。 | |
调用StopCasterScene停止指定场景，限制仅用于PVW的关闭。 | |
调用UpdateCasterSceneConfig增量设置场景配置，不清空原配置，布局信息在原场景上增量修改，效率较全量设置高。 | |
调用DeleteCasterComponent删除组件。 | |
调用DescribeCasterComponents查询导播台组件列表。 | |
调用ModifyCasterComponent修改组件。 | |
调用AddCasterEpisode添加导播台节目。 | |
调用ModifyCasterEpisode修改导播台节目配置，节目类型不允许修改。 | |
调用DeleteCasterEpisode删除导播台节目。 | |
调用AddCasterEpisodeGroup添加导播台节目列表。 | |
调用DeleteCasterEpisodeGroup删除导播台节目列表。 | |
调用AddCasterProgram添加导播台节目单。 | |
调用ModifyCasterProgram修改导播台节目单。 | |
调用DeleteCasterProgram删除导播台节目单。 | |
调用DescribeCasterProgram查询导播台节目单。 | |
调用UpdateCasterSceneAudio更新场景音频配置。 | |
调用DescribeCasterSceneAudio查询场景音频配置信息。 | |
调用SetCasterChannel在视频源同步模式时，将视频资源设置到通道中。 | |
调用DescribeCasterChannels查询导播台通道信息列表。 | |
调用DeleteCasterSceneConfig清除指定场景的配置信息。 | |
调用AddCasterEpisodeGroupContent添加导播台节目列表。 | |
调用AddPlaylistItems添加节目单项。若没有创建过节目单，则直接创建。 | |
调用DeletePlaylistItems删除节目单项。 | |
调用ListPlaylistItems查询指定节目单下的节目单项。 | |
调用EditPlaylist编辑节目单。 | |
调用DeletePlaylist删除整个节目单。 | |
调用ListPlaylist查询节目单。 | |
调用StartPlaylist启动整个节目单。 | |
调用StopPlaylist停止整个节目单。 | |
调用AddShowIntoShowList添加节目到节目单中。 | |
调用RemoveShowFromShowList删除节目单中的一个节目。 | |
调用DescribeShowList查询节目单。 | |
调用ModifyShowList修改播单属性。 | |
调用PlayChoosenShow手动切换节目。 | |
调用AddStudioLayout添加虚拟演播厅的布局设置。 | |
调用DeleteStudioLayout删除虚拟演播厅的布局设置。 | |
调用ModifyStudioLayout修改虚拟演播厅布局。 | |
调用DescribeStudioLayouts获取虚拟演播厅布局设置。 |
云端合流
API | 描述 |
调用CreateMixStream创建合流任务，开始合流。 | |
调用UpdateMixStream更新合流任务。 | |
调用DescribeMixStreamList查询合流任务列表。 | |
调用DeleteMixStream删除合流任务。 | |
调用CreateCustomTemplate创建合流自定义模板。 | |
调用DeleteCustomTemplate删除合流自定义模板。 | |
调用GetCustomTemplate获取合流自定义模板。 | |
调用GetAllCustomTemplates获取全量自定义合流模板。 |
直播水印
API | 描述 |
调用AddLiveStreamWatermark添加水印模板。 | |
调用DeleteLiveStreamWatermark删除指定⽔印模板。 | |
调用UpdateLiveStreamWatermark更新水印模板。 | |
调用DescribeLiveStreamWatermarks查询水印模板列表。 | |
调用AddLiveStreamWatermarkRule添加水印规则。 | |
调用DeleteLiveStreamWatermarkRule删除水印规则。 | |
调用UpdateLiveStreamWatermarkRule更新水印规则。 | |
调用DescribeLiveStreamWatermarkRules查询水印规则列表。 |
直播日志
API | 描述 |
调用EnableLiveRealtimeLogDelivery开启域名实时日志投递。 | |
调用DisableLiveRealtimeLogDelivery暂停域名实时日志投递。 | |
调用ModifyLiveRealtimeLogDelivery更改域名实时日志投递。 | |
调用CreateLiveRealTimeLogDelivery创建域名实时日志投递。 | |
调用DeleteLiveRealtimeLogDelivery删除域名实时日志推送。 | |
调用DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息。 | |
调用ListLiveRealtimeLogDelivery查询用户下所有实时日志投递。 | |
调用ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有有直播域名。 | |
调用ListLiveRealtimeLogDeliveryInfo查询所有实时日志投递服务信息。 | |
调用DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore。 | |
调用DescribeLiveDomainLog查询视频直播指定域名的离线日志信息。 |
直播监播
API | 描述 |
调用CreateLiveStreamMonitor创建监播室。 | |
调用UpdateLiveStreamMonitor更新监播室配置。 | |
调用DescribeLiveStreamMonitorList查询已创建的监播室列表。 | |
调用StartLiveStreamMonitor开启监播。 | |
调用StopLiveStreamMonitor停止监播。 | |
调用DeleteLiveStreamMonitor删除监播室。 |
工具箱
调用DescribeLiveIpInfo验证指定IP是否为CDN节点的IP地址。 |