本产品(视频直播/2016-11-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

域名管理

API标题API概述
AddLiveDomain添加直播域名调用该接口添加直播域名,一次只能提交一个域名。
AddLiveDomainPlayMapping添加主播放和子播放域名映射添加主播流域名和子播流域名映射。
DeleteLiveDomainPlayMapping删除播流域名的映射关系删除主播流域名和子播流域名的映射关系配置。
AddLiveDomainMapping添加播流域名和推流域名的映射关系添加直播域名播流域名和推流域名的映射关系配置。
DeleteLiveDomain删除已添加的直播域名删除本条直播域名的全部相关记录。
DeleteLiveDomainMapping删除直播域名的映射关系删除直播域名播流域名和推流域名的映射关系配置。
DescribeLiveDomainMapping查询直播域名映射查询推流域名、主播流域名和子播流域名映射。
DescribeLiveDomainDetail获取指定直播域名配置的基本信息查询指定推流域名或播流域名的基本配置信息。
DescribeLiveUserDomains查询用户名下所有的直播域名查询用户名下所有的直播域名。
StartLiveDomain启用直播域名启用状态为停用的直播域名,将DomainStatus变更为online。
StopLiveDomain停用直播域名停用状态为启用的直播域名,将DomainStatus变更为offline。
DescribeLiveCertificateDetail查询证书信息查询证书详细信息。
DescribeLiveDomainCertificateInfo查询指定直播域名证书信息获取指定直播域名证书信息。
DescribeLiveCertificateList获取证书列表信息查询指定域名或请求账号下的所有证书列表信息。
SetLiveDomainCertificate设置域名证书设置某域名下证书功能是否启用及修改证书信息。
BatchDeleteLiveDomainConfigs批量删除域名配置批量删除域名配置。
BatchSetLiveDomainConfigs批量配置域名批量配置域名。
DescribeLiveDomainConfigs查询直播域名配置查询直播域名配置,一次可查询多个功能配置。
DescribeLiveDomainByCertificate查询证书匹配的域名列表根据证书信息获取加速域名。
DescribeLiveHttpsDomainList查询证书服务列表接口查询用户证书服务所有已配置证书信息。
ModifyLiveDomainSchdmByProperty修改直播域名加速区域修改直播域名加速区域。
DescribeLiveUserTags获取直播用户标签调用DescribeLiveUserTags查询用户标签。
VerifyLiveDomainOwner验证直播域名拥有者调用VerifyLiveDomainOwner验证域名归属权。

直播预热

API标题API概述
SetLiveStreamPreloadTasks设置直播预热任务设置直播预热任务,支持批量设置直播流预热。
DescribeLiveStreamPreloadTasks查询直播预热任务仅支持查询最近3天内的数据。
HotLiveRtcStream设置RTC流预热设置RTC流预热。

直播拉流

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

直播流管理

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

边缘转推

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

中心转推

API标题API概述
AddLiveCenterTransfer添加直播中心转推配置调用AddLiveCenterTransfer添加直播中心转推配置。
UpdateLiveCenterTransfer修改直播中心转推配置调用UpdateLiveCenterTransfer修改直播中心转推配置。
DescribeLiveCenterTransfer获取直播中心转推调用DescribeLiveCenterTransfer查询直播中心转推配置。
DeleteLiveCenterTransfer删除直播中心转推调用DeleteLiveCenterTransfer删除直播中心转推配置。

主备合流

API标题API概述
DeleteLiveStreamMerge删除在线流合流删除在线流合流。
AddLiveStreamMerge添加主备合流调用AddLiveStreamMerge添加主备合流配置。
DescribeLiveStreamMerge查询主备合流配置调用DescribeLiveStreamMerge查询主备合流配置。

直播延播

API标题API概述
DeleteLiveDelayConfig删除直播延播配置调用DeleteLiveDelayConfig删除直播延播配置。
UpdateLiveDelayConfig更新直播延播配置更新直播延播配置。
DescribeLiveDelayConfig查询直播延播配置调用DescribeLiveDelayConfig查询直播延播配置。
ListLiveDelayConfig查询延播配置列表调用ListLiveDelayConfig查询直播延播配置列表。
CreateLiveDelayConfig设置直播延播配置设置直播延播配置。

推流回调

API标题API概述
SetLiveStreamsNotifyUrlConfig设置推流回调通知地址配置设置推流回调配置。
DescribeLiveStreamsNotifyUrlConfig查询直播推流回调配置查询推流回调配置。
DeleteLiveStreamsNotifyUrlConfig删除直播推流回调配置删除推流回调配置。
DescribeLiveStreamsNotifyRecords查询流回调记录查询流回调记录。

直播安全

API标题API概述
DeleteLiveStreamBlock删除直播流粒度封禁调用DeleteLiveStreamBlock删除直播流粒度封禁。
SetLiveStreamBlock设置直播流粒度封禁调用SetLiveStreamBlock设置直播流粒度封禁。
DescribeStreamLocationBlock查询直播流粒度封禁调用DescribeStreamLocationBlock查询直播流粒度封禁信息。

直播时移

API标题API概述
DescribeLiveShiftConfigs查询域名时移配置调用DescribeLiveShiftConfigs查询指定域名的时移配置。
OpenLiveShift开启时移服务调用OpenLiveShift为指定域名(应用、直播流)开启时移服务。
CloseLiveShift关闭时移服务关闭指定域名(应用、直播流)的时移服务。

直播转码

API标题API概述
AddLiveStreamTranscode添加转码配置信息调用AddLiveStreamTranscode添加转码配置信息。
AddCustomLiveStreamTranscode添加自定义转码配置信息调用AddCustomLiveStreamTranscode添加自定义转码配置信息。
AddRtsLiveStreamTranscode添加RTS自定义转码配置信息调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。
UpdateCustomLiveStreamTranscode更新自定义转码配置更新自定义转码配置信息。
UpdateLiveStreamTranscode更新通用转码配置更新通用转码配置信息。
UpdateRtsLiveStreamTranscode更新RTS自定义转码配置更新RTS自定义转码配置信息。
DeleteLiveStreamTranscode删除转码配置删除转码配置信息。
DescribeLiveStreamTranscodeInfo查询转码配置信息查询转码配置信息。
AddTrancodeSEI添加转码 SEI 信息添加转码SEI信息。

直播录制存储至VOD

API标题API概述
AddLiveRecordVodConfig添加直播录制转点播配置增加直播录制转点播配置,将录制内容保存到点播媒资库。
UpdateLiveRecordVodConfig更新直播录制转点播配置更新直播录制转点播配置。
DeleteLiveRecordVodConfig删除直播录制转点播配置删除直播录制转点播配置。
DescribeLiveRecordVodConfigs查询直播录制转点播配置查询直播转点播配置列表。

直播录制存储至OSS

API标题API概述
AddLiveAppRecordConfig添加录制配置配置APP录制,输出内容保存到OSS中。
RealTimeRecordCommand实时录制指令按需完成手动录制。例如动态启动录制、动态停止录制。
UpdateLiveAppRecordConfig更新直播录制更新配置APP录制,输出内容保存到OSS中。
DeleteLiveAppRecordConfig解除录制配置删除App级别录制配置。
DeleteLiveStreamRecordIndexFiles删除直播录制文件删除直播录制文件。
DescribeLiveRecordConfig查询域名下所有App录制配置查询直播域名下所有APP录制配置。
DescribeLiveStreamRecordContent查询直播流录制内容查询直播录制内容。
CreateLiveStreamRecordIndexFiles创建录制索引文件创建某个时间范围的M3U8索引文件。
DescribeLiveStreamRecordIndexFile查询单个录制索引文件查询单个录制索引文件。
DescribeLiveStreamRecordIndexFiles查询某个时间段内的所有录制索引文件查询某个时间段内的所有录制索引文件。
AddLiveRecordNotifyConfig添加域名级别录制回调配置添加域名级别录制回调配置。
DeleteLiveRecordNotifyConfig删除直播录制回调配置删除域名级别录制回调配置。
DescribeLiveRecordNotifyConfig查询域名级别录制回调配置查询域名级别录制回调配置。
UpdateLiveRecordNotifyConfig更新域名级别录制回调配置更新域名级别录制回调配置。

直播截图

API标题API概述
AddLiveAppSnapshotConfig添加直播截图配置配置截图信息。输出内容保存到OSS中,重新推流即生效。
DeleteLiveAppSnapshotConfig删除直播截图配置解除直播流下AppName的截图配置,重新推流后生效。
DeleteSnapshotFiles删除直播截图文件删除指定截图文件。
DescribeLiveSnapshotConfig查询域名下的截图配置查询播流域名下的截图配置。
UpdateLiveAppSnapshotConfig更新直播截图配置更新直播流下的截图配置。输出内容保存到OSS中,重新推流后生效。
DescribeLiveStreamSnapshotInfo查询一段时间内截图内容查询某一段时间内截图内容。
DescribeLiveSnapshotNotifyConfig获取截图回调配置获取截图回调配置。
DeleteLiveSnapshotNotifyConfig删除截图回调配置删除截图回调配置。
AddLiveSnapshotNotifyConfig添加截图回调配置添加截图回调配置。
UpdateLiveSnapshotNotifyConfig修改截图回调配置修改截图回调配置。
SetSnapshotCallbackAuth设置截图回调鉴权配置设置截图回调鉴权配置。
QuerySnapshotCallbackAuth查询截图回调鉴权配置查询截图回调鉴权配置信息。
DeleteSnapshotCallbackAuth删除截图回调鉴权配置删除截图回调鉴权配置。

直播封装

API标题API概述
AddLivePackageConfig添加直播封装配置调用AddLivePackageConfig添加直播封装配置。
UpdateLivePackageConfig更新直播封装配置调用UpdateLivePackageConfig更新直播封装配置。
DescribeLivePackageConfig查询直播封装配置
DeleteLivePackageConfig删除直播封装配置

直播审核

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

全球加速

API标题API概述
CreateLivePrivateLine创建全球加速实例并绑定到直播链路创建全球加速实例并绑定到直播链路。
DeleteLivePrivateLine删除全球加速实例和直播链路的绑定关系解绑全球加速实例与直播链路。
DescribeLivePrivateLineAreas查询可选的全球加速链路起点查询可选的全球加速链路起点。
DescribeLivePrivateLineAvailGA查询全球加速配置查询全球加速实例和直播链路的绑定信息。

直播延迟

API标题API概述
DescribeLiveStreamDelayConfig查询直播延迟时间调用DescribeLiveStreamDelayConfig查询直播延迟时间。
SetLiveStreamDelayConfig配置直播延迟调用SetLiveStreamDelayConfig配置直播延迟。

监控统计

API标题API概述
DescribeLiveDomainBpsData查询域名网络带宽监控数据调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。
DescribeLiveDomainTrafficData查询直播域名流量数据查询直播域名网络流量监控数据。
DescribeLiveStreamTranscodeMetricData按流粒度查询视频流的转码用量查询指定域名app及流粒度转码数据。
DescribeLiveCenterStreamRateData查询直播中心收录的流音视频帧率和码率查询直播中心流的音视频帧率、码率。
DescribeLiveDomainBpsDataByLayer按协议分类查询域名带宽及流量数据调用DescribeLiveDomainBpsDataByLayer按协议分类获取域名带宽及流量信息。
DescribeLiveDomainPushBpsData查询推流域名推流网络带宽监控数据调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。
DescribeLiveDomainPushTrafficData查询推流域名推流流量监控数据调用DescribeLiveDomainPushTrafficData获取推流域名推流流量监控数据。
DescribeLiveStreamPushMetricDetailData查询指定域名推流流粒度批量数据查询指定域名推流app及流粒度数据。
DescribeLiveDomainPublishErrorCode查询域名推流状态码查询推流域名下某个时间段内的推流状态码。
DescribeLiveUpVideoAudioInfo获取直播视频音频信息查询一段时间内的流的上行推流的音视频参数。
DescribeLiveDomainRealTimeBpsData获取域名1分钟粒度带宽数据调用DescribeLiveDomainRealTimeBpsData获取域名1分钟粒度带宽数据。
DescribeLiveDomainRealTimeTrafficData获取加速域名的1分钟流量监控数据调用DescribeLiveDomainRealTimeTrafficData查询直播域名的实时流量监控数据。
DescribeLiveDomainRealTimeHttpCodeData查询直播域名实时HTTP返回码占比获取加速域名1分钟粒度的HTTP返回码占比。
DescribeLiveStreamHistoryUserNum查询直播流历史在线人数调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。
DescribeLiveStreamCount查询在线直播流数量获取直播流的实时在线原始流和转码流流数信息。
DescribeLiveStreamTranscodeStreamNum获取直播流转码流数量调用DescribeLiveStreamTranscodeStreamNum实时查询转码流路数。
DescribeLiveDomainPvUvData查询直播域名PV/UV数据调用DescribeLiveDomainPvUvData查询指定直播域名的PV、UV数据。
DescribeLiveTopDomainsByFlow获取流最多域名调用DescribeLiveTopDomainsByFlow获取用户按流量排名的域名。
DescribeLiveStreamsTotalCount获取天粒度累计直播流路数调用DescribeLiveStreamsTotalCount接口获取天粒度累计直播流路数。
DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据调用DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据,单次查询最多返回5000行数据。
DescribeLiveStreamDetailFrameRateAndBitRateData查询RTMP协议直播流的详细音视频帧率码率查询RTMP协议直播流的详细音视频帧率码率。

用量查询

API标题API概述
DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。
DescribeLiveDomainSnapshotData查询直播域名截图张数数据调用DescribeLiveDomainSnapshotData查询直播域名截图张数。
DescribeLiveDetectPornData查询直播审核用量数据调用DescribeLiveDetectPornData获取查询直播审核用量数据。
DescribeDomainUsageData查询域名在特定计费区域的用量数据调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。
DescribeLivePushProxyUsageData查询直播中心转推用量数据调用DescribeLivePushProxyUsageData查询直播中心转推用量数据。
DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数调用DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数。
DescribeLiveDomainTimeShiftData查询直播时移用量数据调用DescribeLiveDomainTimeShiftData查询直播时移用量数据。
DescribeLiveDomainStreamTranscodeData查询域名转码用量数据调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。
DescribeLiveProducerUsageData查询导播台用量数据调用DescribeLiveProducerUsageData查询导播台用量数据。
DescribeLiveDomainMonitoringUsageData获取域名广目监播用量调用DescribeLiveDomainMonitoringUsageData获取域名广目监播用量数据。
DescribeLiveDelayedStreamingUsage查询延播时长数据调用DescribeLiveDelayedStreamingUsage查询延播时长用量数据。
DescribeLiveGrtnDuration查询连麦通话时长用量数据调用DescribeLiveGrtnDuration查询连麦通话时长用量数据。
DescribeMeterLiveBypassDuration查询混流转码用量数据DescribeMeterLiveBypassDuration
DescribeLiveDrmUsageData获取直播DRM用量数据

云导播

API标题API概述
导播台管理导播台管理
CreateCaster创建导播台调用CreateCaster创建导播台。
SetCasterConfig设置导播台配置配置导播台,全量覆盖配置信息,若指定参数置为空则清除导播台该项配置。
DescribeCasterConfig查询导播台配置查询导播台配置信息。
DescribeCasters查询导播台列表调用DescribeCasters查询导播台列表。
DescribeCasterStreamUrl查询导播台流信息列表查询导播台流地址。
CopyCaster复制导播台复制导播台,复制指定导播台并返回新导播台实例。
StartCaster启动导播台启动导播台。若PVW、PGM场景不存在则创建,启动PVW、PGM场景,启动底层音视频处理任务。
StopCaster停止导播台停止导播台。停止PVW(预览场景)、PGM(正式输出场景)场景。
DeleteCaster删除导播台调用DeleteCaster删除导播台。
RestartCaster重启导播台调用RestartCaster重启导播台。
输入源媒体管理输入源媒体管理
AddCasterVideoResource添加导播台视频资源添加视频源,视频源数量受限于导播台输入路数。
DeleteCasterVideoResource删除导播台视频资源删除视频资源。
ModifyCasterVideoResource修改导播台视频源修改导播台视频资源。
DescribeCasterVideoResources查询导播台视频源查询导播台视频源。
布局管理布局管理
AddCasterLayout添加导播台布局添加导播台布局。
DeleteCasterLayout删除导播台布局数据删除布局数据。
ModifyCasterLayout修改导播台布局修改布局配置,传递修改项,非修改内容无需传递。
DescribeCasterLayouts查询导播台布局列表查询导播台布局列表。
组件管理组件管理
AddCasterComponent添加导播台组件调用AddCasterComponent添加导播台组件。
DeleteCasterComponent删除导播台组件调用DeleteCasterComponent删除导播台组件。
ModifyCasterComponent修改导播台组件调用ModifyCasterComponent修改导播台组件。
DescribeCasterComponents查询导播台组件列表调用DescribeCasterComponents查询导播台组件列表。
场景与音频管理场景与音频管理
CopyCasterSceneConfig复制导播台场景配置将原场景配置应用至目标场景并生效,仅限PVW场景配置拷贝至PGM场景。
DeleteCasterSceneConfig清除导播台的指定场景的配置信息删除导播台场景配置。
UpdateCasterSceneConfig更新导播场景配置增量设置场景配置,不清空原配置,布局信息在原场景上增量修改,效率较全量设置高。
SetCasterSceneConfig全量设置导播台场景配置全量设置场景配置,清空场景配置,并将布局信息设置并生效至指定场景。
DescribeCasterScenes查询场景信息列表查询导播台场景列表。
UpdateCasterSceneAudio更新场景音频配置增加场景音频配置,将原场景音频添加到新场景。
DescribeCasterSceneAudio查询场景音频配置信息查询场景音频配置。
StartCasterScene启动导播台场景启动指定场景,限制仅用于PVW的打开。
StopCasterScene停止导播台场景停止指定场景,限制仅用于停止PVW场景(预览场景)。
通道管理通道管理
SetCasterChannel设置导播台通道设置导播台通道。
DescribeCasterChannels查询导播台通道信息列表查询导播台通道。
备播管理备播管理
EffectCasterUrgent切换导播台备播切换导播台备播。
EffectCasterVideoResource更新导播台备播片更新导播台备播片。
新播单型导播台管理新播单型导播台管理
AddShowIntoShowList添加一个节目到节目单添加节目到节目单中。
RemoveShowFromShowList删除节目单中的节目删除节目单中的节目。
ModifyShowList修改播单属性修改播单属性。
DescribeShowList节目单查询查询节目单。
PlayChoosenShow手动切换节目手动切换节目。
InitializeAutoShowListTask创建一个定时任务创建一个定时任务。
DescribeAutoShowListTasks查询自动启停的定时任务查询自动启停的定时任务。
EditShowAndReplace添加剪辑任务添加剪辑任务。
GetEditingJobInfo查询剪辑任务查询剪辑任务信息。
SetShowListBackground播单背景设置进行播单背景设置。
虚拟演播厅管理虚拟演播厅管理
AddStudioLayout添加虚拟演播厅布局添加虚拟演播厅的布局设置。
DeleteStudioLayout删除虚拟演播厅布局删除虚拟演播厅的布局设置。
ModifyStudioLayout修改虚拟演播厅布局修改虚拟演播厅布局。
DescribeStudioLayouts查询虚拟演播厅布局获取虚拟演播厅布局设置。
(旧)播单型导播台(旧)播单型导播台
AddCasterEpisode添加导播台节目添加导播台节目。
DeleteCasterEpisode删除导播台节目删除导播台节目。
ModifyCasterEpisode修改导播台节目配置,节目类型不允许修改修改导播台节目配置,节目类型不允许修改。
AddCasterEpisodeGroup添加导播台节目列表添加导播台节目列表。
DeleteCasterEpisodeGroup删除导播台节目列表删除导播台节目列表。
AddCasterEpisodeGroupContent添加导播台节目列表添加导播台节目列表信息。
AddCasterProgram添加导播台节目单添加导播台节目单。
DescribeCasterProgram查询导播台节目单查询导播台节目单。
ModifyCasterProgram修改导播台节目单修改导播台节目单。
DeleteCasterProgram删除导播台节目单删除导播台节目单。
AddPlaylistItems添加播放列表项添加节目单项。
DeletePlaylistItems删除播放列表项目删除节目单项。
ListPlaylistItems列出播放列表项查询指定节目单下的节目单项。
EditPlaylist编辑播放列表编辑节目单。
DeletePlaylist删除播放列表删除整个节目单。
ListPlaylist获取播放列表查询节目单。
StartPlaylist开始播放列表项启动整个节目单。
StopPlaylist停止节目单停止整个节目单。

云端合流

API标题API概述
CreateMixStream创建合流任务创建合流任务。
UpdateMixStream更新合流任务更新合流任务。
DescribeMixStreamList查询合流任务列表查询合流任务列表。
DeleteMixStream删除合流任务删除合流任务。
CreateCustomTemplate创建合流自定义模板创建合流自定义模板。
DeleteCustomTemplate删除合流自定义模板删除合流自定义模板。
GetCustomTemplate获取自定义合流模板获取合流自定义模板。
GetAllCustomTemplates获取全量自定义合流模板获取全量自定义合流模板。

直播水印

API标题API概述
AddLiveStreamWatermark添加⽔印模板调用AddLiveStreamWatermark添加水印模板。
DeleteLiveStreamWatermark删除⽔印模板调用DeleteLiveStreamWatermark删除指定⽔印模板。
UpdateLiveStreamWatermark更新水印模板调用UpdateLiveStreamWatermark更新水印模板。
DynamicUpdateWaterMarkStreamRule动态更新水印调用DynamicUpdateWaterMarkStreamRule动态更新水印。
DescribeLiveStreamWatermarks查询水印模板列表调用DescribeLiveStreamWatermarks查询水印模板列表。
AddLiveStreamWatermarkRule添加水印规则调用AddLiveStreamWatermarkRule添加水印规则。
DeleteLiveStreamWatermarkRule删除水印规则调用DeleteLiveStreamWatermarkRule删除水印规则。
UpdateLiveStreamWatermarkRule更新水印规则调用UpdateLiveStreamWatermarkRule更新水印规则。
DescribeLiveStreamWatermarkRules查询水印规则列表调用DescribeLiveStreamWatermarkRules查询水印规则列表。

边缘转码

API标题API概述
ListEdgeTranscodeTemplate查询边缘转码模板列表查询边缘转码模板列表。
GetEdgeTranscodeTemplate查询边缘转码模板详情查询边缘转码模板详情。
CreateEdgeTranscodeJob创建边缘转码任务创建边缘转码任务。
DeleteEdgeTranscodeJob删除边缘转码任务删除边缘转码任务。
ListEdgeTranscodeJob查询边缘转码任务列表查询边缘转码任务列表。
GetEdgeTranscodeJob查询边缘转码任务详情查询边缘转码任务详情。
UpdateEdgeTranscodeJob更新边缘转码任务更新边缘转码任务。
StartEdgeTranscodeJob启动边缘转码任务启动边缘转码任务。
StopEdgeTranscodeJob停止边缘转码任务停止边缘转码任务。

直播日志

API标题API概述
EnableLiveRealtimeLogDelivery开启域名实时日志投递调用EnableLiveRealtimeLogDelivery开启域名实时日志投递。
DisableLiveRealtimeLogDelivery暂停域名实时日志投递调用DisableLiveRealtimeLogDelivery暂停域名实时日志投递。
ModifyLiveRealtimeLogDelivery更改域名实时日志投递调用ModifyLiveRealtimeLogDelivery更改域名实时日志投递。
CreateLiveRealTimeLogDelivery创建域名实时日志投递调用CreateLiveRealTimeLogDelivery创建域名实时日志投递。
DeleteLiveRealtimeLogDelivery删除域名实时日志推送调用DeleteLiveRealtimeLogDelivery删除域名实时日志推送。
DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息调用DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息。
ListLiveRealtimeLogDelivery查询用户下所有实时日志投递调用ListLiveRealtimeLogDelivery查询用户下所有实时日志投递。
ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有直播域名调用ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有直播域名。
ListLiveRealtimeLogDeliveryInfos查询所有实时日志投递服务信息调用ListLiveRealtimeLogDeliveryInfo查询所有实时日志投递服务信息。
DescribeLivePushProxyLog查询转推离线日志下载地址通过DescribeLivePushProxyLog,获取直播转推离线日志下载地址。
DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore调用DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore。
DescribeLiveDomainLog日志下载获取直播指定域名的原始访问日志的下载地址。

直播监播

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

互动消息(新)

API标题API概述
CreateLiveMessageApp创建互动消息应用调用CreateLiveMessageApp创建互动消息应用。
CreateLiveMessageGroup创建直播互动群组调用CreateLiveMessageGroup创建互动消息群组。
DescribeLiveMessageGroup查询直播互动群组详细信息查询直播互动群组详细信息。
ModifyLiveMessageGroup修改直播互动群组信息调用ModifyLiveMessageGroup修改互动消息群组信息。
DeleteLiveMessageGroup删除直播互动群组调用DeleteLiveMessageGroup删除互动消息群组。
ListLiveMessageGroups查询直播互动群组列表调用ListLiveMessageGroups查询互动消息群组列表。
ListLiveMessageGroupByPage查询互动消息群组列表(支持翻页)查询互动消息群组列表,并支持翻页功能。
ModifyLiveMessageGroupBand修改用户禁言状态修改用户禁言状态。
DescribeLiveMessageGroupBand查询用户禁言状态信息调用DescribeLiveMessageGroupBand查询用户禁言状态信息。
CheckLiveMessageUsersOnline查询指定的用户是否在线调用CheckLiveMessageUsersOnline查询指定的用户是否在线。
CheckLiveMessageUsersInGroup查询指定用户是否在群组中调用CheckLiveMessageUsersInGroup查询指定用户是否在群组中。
ListLiveMessageGroupUsers查询群组用户列表调用ListLiveMessageGroupUsers查询群组用户列表。
ListLiveMessageGroupMessages查询群组消息列表调用ListLiveMessageGroupMessages查询群组消息列表。
UnbanLiveMessageGroup解除群组全员禁言调用UnbanLiveMessageGroup新增禁言用户。
RecoverLiveMessageDeletedGroup恢复已删除的互动消息群组调用RecoverLiveMessageDeletedGroup恢复已删除的互动消息群组。
BanLiveMessageGroup群组全员禁言调用BanLiveMessageGroup新增禁言用户。
AddLiveMessageGroupBand新增禁言用户调用AddLiveMessageGroupBand新增禁言用户。
RemoveLiveMessageGroupBand解除禁言用户解除直播互动群组用户禁言
DeleteLiveMessageGroupMessage删除(撤回)某条群组消息调用DeleteLiveMessageGroupMessage删除(撤回)某条群组消息。
DeleteLiveMessageUserMessage删除(撤回)某条单聊消息调用DeleteLiveMessageUserMessage删除(撤回)某条单聊消息。
SendLiveMessageGroup发送消息到群组发送消息到群组。
SendLiveMessageUser发送消息到用户发送消息到用户。
ListLiveMessageApps查询直播互动应用列表调用ListLiveMessageApps查询互动消息应用列表。
DescribeLiveMessageApp查询直播互动应用信息调用DescribeLiveMessageApp查询互动消息应用信息。
ModifyLiveMessageAppDisable修改直播互动应用禁用信息修改App禁用。
ModifyLiveMessageAppAudit修改直播互动应用鉴权信息修改互动消息应用安全审核设置。
ModifyLiveMessageAppCallback修改直播互动应用回调信息修改互动消息应用回调信息。
KickLiveMessageGroupUser将指定用户从群组中踢出去踢出互动消息群组用户。
ModifyLiveMessageUserInfo修改用户信息修改用户信息。

实时音视频

API标题API概述
频道管理频道管理
DescribeChannelParticipants查询频道内在线用户列表查询频道内在线用户列表。
DescribeChannelUsers查询频道内在线用户列表查询频道内在线用户列表的详细信息。
RemoveTerminals从频道中踢出指定终端用户从频道中踢出指定终端用户。
CreateRoomRealTimeStreamAddress创建RTMP流在房间中的推流地址创建RTMP流在房间中的推流地址。
DeleteChannel删除频道删除频道。
旁路转推旁路转推
StartLiveMPUTask创建混流转推任务(新)创建混流转推任务。
UpdateLiveMPUTask更新混流转推任务(新)更新混流转推任务。
StopLiveMPUTask停止混流转推任务(新)停止混流转推任务。
ListRtcMPUTaskDetail查询混流转推任务参数明细查询混流转推任务参数明细。
SetLiveMpuTaskSei设置自定义SEI设置连麦旁路自定义sei。
事件回调事件回调
CreateEventSub创建订阅房间消息回调创建订阅房间消息的回调。
ListEventSub查询订阅房间消息列表查询订阅房间消息列表。
ListEventSubEvent查询回调记录查询回调记录。
UpdateEventSub更新订阅房间消息回调更新订阅房间消息回调。
DeleteEventSub删除订阅房间消息回调删除订阅房间消息的回调。
CreateRtcMPUEventSub创建混流转推事件订阅创建混流转推事件订阅。
UpdateRtcMPUEventSub更新混流转推事件订阅更新混流转推事件订阅。
DeleteRtcMPUEventSub删除混流转推事件订阅删除混流转推事件订阅。
DescribeRtcMPUEventSub查询混流转推事件订阅查询混流转推事件订阅。
ListRtcMPUEventSubRecord查询混流转推事件订阅记录查询混流转推事件订阅记录。
质量数据质量数据
DescribeLiveInteractionMetricData查询实时音视频指标数据调用DescribeLiveInteractionMetricData查询实时音视频指标数据。
实时语音转文字/翻译实时语音转文字/翻译
CreateRtcAsrTask创建实时语音转文字或翻译创建一个新的实时字幕任务,用于实时转录音频流为文本。
QueryRtcAsrTasks查询实时语音转文字或翻译查询当前已创建的实时语音转文字或翻译任务的状态信息。
StopRtcAsrTask停止实时语音转文字或翻译调用StopRtcAsrTask停止实时字幕任务。
DeleteRtcAsrTask删除实时语音转文字或翻译任务调用DeleteRtcAsrTask删除实时语音转文字或翻译任务。

高级功能

API标题API概述
触发规则配置触发规则配置
DeleteLiveAIProduceRules删除字幕规则删除字幕规则。
DescribeLiveAIProduceRules查询字幕规则查询字幕规则列表。
UpdateLiveAIProduceRules更新实时字幕规则更新字幕规则。
AddLiveAIProduceRules添加实时字幕规则添加字幕规则。
AI模板配置AI模板配置
DeleteLiveAISubtitle删除字幕模板调用DeleteLiveAISubtitle删除指定字幕模板。
DescribeLiveAISubtitle查询字幕模板调用DescribeLiveAISubtitle查询字幕模板列表。
UpdateLiveAISubtitle更新字幕模板调用UpdateLiveAISubtitle更新字幕模板。
AddLiveAISubtitle添加直播字幕模板调用AddLiveAISubtitle添加字幕模板。

工具箱

API标题API概述
DescribeLiveIpInfo获取直播IP信息调用DescribeLiveIpInfo验证指定IP是否为CDN节点的IP地址。
DescribeLiveStreamAuthChecking查询流鉴权查询当前在线流的鉴权。