阿里雲ApsaraVideo for Live的OpenAPI採用RPC簽名風格，簽名細節參見RPC 調用機制。本文為您介紹了ApsaraVideo for Live服務的所有API列表，建議您使用服務端SDK來調用API。
網域名稱管理
API | 描述 |
調用AddLiveDomain添加直播網域名稱，一次只能提交一個網域名稱。 | |
調用AddLiveDomainPlayMapping添加主播流網域名稱和子播流網域名稱映射。 | |
調用DeleteLiveDomainPlayMapping刪除主播流網域名稱和子播流網域名稱的映射關係配置。 | |
調用AddLiveDomainMapping添加播流網域名稱和推流網域名稱的映射關係配置。 | |
調用DeleteLiveDomain刪除已添加的直播網域名稱。 | |
調用DeleteLiveDomainMapping刪除播流網域名稱和推流網域名稱的映射關係配置。 | |
調用DescribeLiveDomainMapping查詢推流網域名稱、主播流網域名稱和子播流網域名稱映射。 | |
調用DescribeLiveDomainDetail擷取指定直播網域名稱配置的基本資料。 | |
調用DescribeLiveUserDomains查詢使用者名稱下所有的直播網域名稱。 | |
調用StartLiveDomain啟用狀態為停用的直播網域名稱，將DomainStatus變更為online。 | |
調用StopLiveDomain停用某個直播網域名稱，將DomainStatus變更為offline。 | |
調用DescribeLiveCertificateDetail擷取認證詳細資料。 | |
調用DescribeLiveDomainCertificateInfo擷取指定直播網域名稱認證資訊。 | |
調用DescribeLiveCertificateList擷取認證列表資訊。 | |
調用DescribeLiveHttpsDomainList查詢使用者認證服務所有已配置認證資訊。 | |
調用DescribeLiveDomainByCertificate根據認證資訊擷取加速網域名稱。 | |
調用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 | 描述 |
調用AddLiveStreamMerge添加主備合流配置。 | |
調用DeleteLiveStreamMerge刪除主備合流配置。 | |
調用DescribeLiveStreamMerge查詢主備合流配置。 |
直播延播
API | 單使用者QPS限制 |
調用CreateLiveDelayConfig設定直播延播配置。 | |
調用ListLiveDelayConfig查詢直播延播配置列表。 | |
調用DescribeLiveDelayConfig查詢直播延播配置。 | |
調用UpdateLiveDelayConfig更新直播延播配置。 | |
調用DeleteLiveDelayConfig刪除直播延播配置。 |
推流回調
API | 描述 |
調用SetLiveStreamsNotifyUrlConfig設定推流回調配置。 | |
調用DescribeLiveStreamsNotifyUrlConfig查詢推流回調配置。 | |
調用DeleteLiveStreamsNotifyUrlConfig刪除推流回調配置。 |
直播安全
API | 描述 |
調用DescribeStreamLocationBlock查詢直播流粒度封鎖資訊。 | |
調用SetLiveStreamBlock設定直播流粒度封鎖。 | |
調用DeleteLiveStreamBlock刪除直播流粒度封鎖。 |
直播時移
API | 描述 |
調用DescribeLiveShiftConfigs查詢指定網域名稱的時移配置。 | |
調用OpenLiveShift為指定網域名稱（應用、直播流）開啟時移服務。 | |
調用CloseLiveShift關閉指定網域名稱（應用、直播流）的時移服務。 |
直播轉碼
API | 描述 |
調用AddLiveStreamTranscode添加轉碼配置資訊。 | |
調用AddCustomLiveStreamTranscode添加自訂轉碼配置資訊。 | |
調用AddRtsLiveStreamTranscode添加RTS自訂轉碼配置資訊。 | |
調用DeleteLiveStreamTranscode刪除轉碼配置資訊。 | |
調用DescribeLiveStreamTranscodeInfo查詢轉碼配置資訊。 | |
調用AddTrancodeSEI添加轉碼SEI資訊。 |
直播錄製儲存至VOD
API | 描述 |
調用AddLiveRecordVodConfig增加直播錄製轉點播配置，將錄製內容儲存到點播媒資庫。 | |
調用UpdateLiveRecordVodConfig更新直播錄製轉點播配置。 | |
調用DescribeLiveRecordVodConfigs查詢直轉點配置列表。 | |
調用DeleteLiveRecordVodConfig刪除直播錄製轉點播配置。 |
直播錄製儲存至OSS
API | 描述 |
調用AddLiveAppRecordConfig配置App錄製，輸出內容儲存到OSS中。 | |
調用UpdateLiveAppRecordConfig更新App層級錄製和流層級錄製。 | |
調用RealTimeRecordCommand按需完成手動錄製。例如動態啟動錄製、動態停止錄製。 | |
調用DeleteLiveAppRecordConfig解除錄製配置。 | |
調用DescribeLiveRecordConfig查詢網域名稱下所有App錄製配置。 | |
調用DescribeLiveStreamRecordContent查詢錄製內容。 | |
調用CreateLiveStreamRecordIndexFiles建立錄製索引檔案。 | |
調用DescribeLiveStreamRecordIndexFile查詢單個錄製索引檔案。 | |
調用DescribeLiveStreamRecordIndexFiles查詢某個時間段內的所有錄製索引檔案。 | |
調用AddLiveRecordNotifyConfig添加網域名稱層級錄製回調配置。 | |
調用DeleteLiveRecordNotifyConfig刪除網域名稱層級錄製回調配置。 | |
調用DescribeLiveRecordNotifyConfig查詢網域名稱層級錄製回調配置。 | |
調用UpdateLiveRecordNotifyConfig更新網域名層級錄製回調配置。 | |
調用DeleteLiveStreamRecordIndexFiles刪除直播錄製檔案。 |
直播截圖
API | 描述 |
調用AddLiveAppSnapshotConfig配置截圖資訊。輸出內容儲存到OSS中，重新推流即生效。 | |
調用DeleteLiveAppSnapshotConfig解除直播流下AppName的截圖配置，重新推流後生效。 | |
調用DescribeLiveSnapshotConfig查詢網域名稱下的截圖配置。 | |
調用UpdateLiveAppSnapshotConfig更新直播流下的截圖配置。輸出內容儲存到OSS中，重新推流後生效。 | |
調用DescribeLiveStreamSnapshotInfo查詢一段時間內截圖內容。 | |
調用AddLiveSnapshotNotifyConfig添加截圖回調配置。 | |
調用UpdateLiveSnapshotNotifyConfig修改截圖回調配置。 | |
調用DescribeLiveSnapshotNotifyConfig擷取截圖回調配置。 | |
調用DeleteLiveSnapshotNotifyConfig刪除截圖回調配置。 |
直播封裝
API | 描述 |
調用AddLivePackageConfig添加直播封裝配置。 | |
調用UpdateLivePackageConfig更新直播封裝配置。 | |
調用DescribeLivePackageConfig查詢直播封裝配置。 | |
調用DeleteLivePackageConfig刪除直播封裝配置。 |
直播審核
API | 描述 |
調用AddLiveSnapshotDetectPornConfig可按照網域名稱和App層級配置直播流審核服務。 | |
調用AddLiveDetectNotifyConfig添加回調通知地址。 | |
調用DescribeLiveSnapshotDetectPornConfig查詢審核配置。 | |
調用DescribeLiveDetectNotifyConfig查詢回調通知地址。 | |
調用UpdateLiveSnapshotDetectPornConfig更新審核配置。 | |
調用UpdateLiveDetectNotifyConfig更新回調通知地址。 | |
調用DeleteLiveSnapshotDetectPornConfig刪除直播審核的配置。 | |
調用DeleteLiveDetectNotifyConfig刪除回調通知地址。 | |
調用AddLiveAudioAuditConfig添加直播語音審核配置。 | |
調用AddLiveAudioAuditNotifyConfig添加音頻審核回調資訊。 | |
調用DeleteLiveAudioAuditConfig刪除直播語音審核配置。 | |
調用DeleteLiveAudioAuditNotifyConfig刪除直播語音審核回調配置。 | |
調用UpdateLiveAudioAuditNotifyConfig更新音頻審核回調資訊。 | |
調用UpdateLiveAudioAuditConfig更新直播語音審核配置。 | |
調用DescribeLiveAudioAuditConfig查詢直播語音審核配置 | |
調用DescribeLiveAudioAuditNotifyConfig直播語音審核回調配置查詢。 |
直播延遲
API | 描述 |
調用DescribeLiveStreamDelayConfig查詢直播延遲時間。 | |
調用SetLiveStreamDelayConfig配置直播延遲。 |
GAGlobal Acceleration
API | 描述 |
調用DescribeLivePrivateLineAreas查詢可選的Global Acceleration鏈路起點。 | |
調用CreateLivePrivateLine建立Global Acceleration執行個體並綁定到直播鏈路。 | |
調用DescribeLivePrivateLineAvailGa查詢Global Acceleration執行個體和直播鏈路的綁定資訊。 | |
調用DeleteLivePrivateLine將Global Acceleration執行個體與直播鏈路解除綁定。 |
監控統計
API | 描述 |
調用DescribeLiveDomainBpsData查詢直播網域名稱的網路頻寬監控資料。 | |
調用DescribeLiveDomainTrafficData查詢直播網域名稱網路流量監控資料。 | |
調用DescribeLiveDomainPushBpsData擷取推流網域名稱的推流網路頻寬監控資料。 | |
調用DescribeLiveDomainPushTrafficData擷取推流網域名稱的推流流量監控資料。 | |
調用DescribeLiveDomainRealTimeBpsData查詢直播網域名稱即時頻寬資料。 | |
調用DescribeLiveDomainRealTimeTrafficData擷取加速網域名稱的1分鐘流量監控資料。 | |
調用DescribeLiveStreamHistoryUserNum查詢直播流歷史線上人數。 | |
調用DescribeLiveDomainRealTimeHttpCodeData擷取加速網域名稱1分鐘粒度的HTTP返回碼佔比資料。 | |
調用DescribeLiveStreamCount擷取直播流的即時線上原始流和轉碼流流數資訊。 | |
調用DescribeLiveStreamsTotalCount介面擷取天粒度累計直播流路數。 | |
調用DescribeLiveDomainPvUvData查詢指定直播網域名稱的PV、UV資料。 |
邊緣指令碼
API | 描述 |
調用DescribeLiveDomainStagingConfig查詢灰階環境配置資訊。 | |
調用SetLiveDomainStagingConfig設定或修改灰階環境下的網域名稱配置。 | |
調用DeleteLiveSpecificStagingConfig刪除灰階環境下的網域名稱配置。 | |
調用PublishLiveStagingConfigToProduction將灰階配置轉為生產配置。 | |
調用RollbackLiveStagingConfig將灰階環境配置復原。 |
用量查詢
API | 描述 |
調用DescribeLiveDomainRecordUsageData查詢直播錄製路數、轉封裝用量。 | |
調用DescribeLiveDomainSnapshotData查詢直播網域名稱截圖張數資料。 | |
調用DescribeDomainUsageData查詢網域名稱在特定計費地區的用量資料。 | |
調用DescribeLivePushProxyUsageData查詢直播中心轉推用量資料。 | |
調用DescribeLiveDomainTimeShiftData查詢直播時移用量資料。 | |
調用DescribeLiveDomainStreamTranscodeData查詢網域名稱轉碼用量資料。 | |
調用DescribeLiveProducerUsageData查詢導播台用量資料。 | |
調用DescribeLiveDomainMonitoringUsageData擷取網域名稱廣目監播用量資料。 | |
調用DescribeLiveDelayedStreamingUsage查詢延播時間長度用量資料。 | |
調用DescribeLiveGrtnDuration查詢連麥通話時間長度用量資料。 | |
調用DescribeMeterLiveBypassDuration查詢混流轉碼用量資料。 |
雲導播
雲導播介面概覽及分組，請參見API概覽。
API | 描述 |
調用CreateCaster建立導播台。 | |
調用AddCasterLayout添加導播檯布局。 | |
調用AddCasterVideoResource添加視頻源，視頻源數量受限於導播台輸入路數。 | |
調用CopyCaster複製導播台，複製指定導播台並返回新導播台執行個體。 | |
調用CopyCasterSceneConfig將原情境配置應用至目標情境並生效，僅限PVW情境配置拷貝至PGM情境。 | |
調用AddCasterComponent添加組件。 | |
調用DeleteCaster刪除導播台。 | |
調用RestartCaster重啟導播台。 | |
調用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 | 描述 |
調用AddLiveStreamWatermark添加浮水印模板。 | |
調用DeleteLiveStreamWatermark刪除指定⽔印模板。 | |
調用UpdateLiveStreamWatermark更新浮水印模板。 | |
調用DescribeLiveStreamWatermarks查詢浮水印模板列表。 | |
調用AddLiveStreamWatermarkRule添加浮水印規則。 | |
調用DeleteLiveStreamWatermarkRule刪除浮水印規則。 | |
調用UpdateLiveStreamWatermarkRule更新浮水印規則。 | |
調用DescribeLiveStreamWatermarkRules查詢浮水印規則列表。 |
直播監播
API | 描述 |
調用CreateLiveStreamMonitor建立監播室。 | |
調用UpdateLiveStreamMonitor更新監播室配置。 | |
調用DescribeLiveStreamMonitorList查詢已建立的監播室列表。 | |
調用StartLiveStreamMonitor開啟監播。 | |
調用StopLiveStreamMonitor停止監播。 | |
調用DeleteLiveStreamMonitor刪除監播室。 |
即時音視頻
API | 描述 |
調用DescribeChannelParticipants查詢頻道內線上使用者列表。 | |
調用RemoveTerminals將指定終端使用者從頻道踢出。 | |
調用DeleteChannel刪除頻道。 | |
調用GetMPUTaskStatus擷取旁路轉推任務狀態。 | |
調用StartLiveMPUTask建立混流轉推任務。 | |
調用UpdateLiveMPUTask更新混流轉推任務。 | |
調用StopLiveMPUTask停止混流轉推任務。 | |
調用StartMPUTask開始旁路轉推任務。 | |
調用UpdateMPUTask更新旁路轉推任務。 | |
調用StopMPUTask停止旁路轉推任務。 | |
調用CreateEventSub建立訂閱房間訊息的回調。 | |
調用DeleteEventSub刪除訂閱房間訊息的回調。 |
即時字幕（公測）
API | 描述 |
調用AddLiveAISubtitle添加字幕模板 | |
調用UpdateLiveAISubtitle更新字幕模板。 | |
調用DescribeLiveAISubtitle查詢字幕模板列表。 | |
調用DeleteLiveAISubtitle刪除指定字幕模板。 | |
調用AddLiveAIProduceRules添加字幕規則。 | |
調用UpdateLiveAIProduceRules更新字幕規則。 | |
調用DescribeLiveAIProduceRules查詢字幕規則列表。 | |
調用DeleteLiveAIProduceRules刪除字幕規則。 |
工具箱
API | 描述 |
調用DescribeLiveIpInfo驗證指定IP是否為CDN節點的IP地址。 |