API標準及多語言預置SDK
本產品(live/2016-11-01)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
網域管理
|
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驗證網域名稱歸屬權。 |
| DescribeLiveVerifyContent | 查詢校正歸屬權內容 | 用於擷取指定網域名稱的歸屬校正內容。 |
| ChangeLiveDomainResourceGroup | 直播網域名稱資源轉組 | 更改直播網域名稱所屬的資源群組,即從原有資源群組移入指定的資源群組。 |
直播預熱
|
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概述 |
| DeleteLiveStreamMerge | 刪除線上流合流 | 刪除線上流合流。 |
| AddLiveStreamMerge | 添加主備合流 | 調用AddLiveStreamMerge添加主備合流配置。 |
| 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 | 查詢網域名稱時移配置 | 查詢指定網域名稱的時移配置。 |
| 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 | 更新網域層級錄製回呼配置 | 更新網域層級錄製回呼配置。 |
| DescribeLiveRecordNotifyRecords | 查詢直播錄製回呼記錄。 | 查詢直播錄製儲存至OSS的回呼記錄。 |
直播截圖
|
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 | 建立Global Acceleration執行個體並綁定到直播鏈路 | 建立Global Acceleration執行個體並綁定到直播鏈路。 |
| DeleteLivePrivateLine | 刪除Global Acceleration執行個體和直播鏈路的綁定關係 | 解除綁定Global Acceleration執行個體與直播鏈路。 |
| DescribeLivePrivateLineAreas | 查詢可選的Global Acceleration鏈路起點 | 查詢可選的Global Acceleration鏈路起點。 |
| DescribeLivePrivateLineAvailGA | 查詢Global Acceleration配置 | 查詢Global Acceleration執行個體和直播鏈路的綁定資訊。 |
直播延遲
|
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資料 | 查詢指定直播網域名稱的PV、UV資料。 |
| DescribeLiveTopDomainsByFlow | 取得流量最多網域 | 呼叫 DescribeLiveTopDomainsByFlow 取得使用者按流量排名的網域。 |
| DescribeLiveStreamsTotalCount | 取得天粒度累計直播流路數 | 調用DescribeLiveStreamsTotalCount介面取得天粒度累計直播流路數。 |
| DescribeLiveStreamMetricDetailData | 查詢指定網域名稱流粒度批次資料 | 呼叫 DescribeLiveStreamMetricDetailData 查詢指定網域名稱流粒度批次資料,單次查詢最多返回 5000 行資料。 |
| DescribeLiveStreamDetailFrameRateAndBitRateData | 查詢RTMP協議直播流的詳細音視訊框架率碼率 | 查詢RTMP協議直播流的詳細音視訊框架率碼率。 |
| DescribeLiveUserStreamMetricData | 查詢指定網域流粒度批量資料 | 用於查詢指定加速網域下的流粒度批量資料,支援多種協定。 |
用量查詢
|
API |
標題 |
API概述 |
| DescribeLiveDomainRecordUsageData | 查詢直播錄製路數、轉封裝用量 | 呼叫 DescribeLiveDomainRecordUsageData 查詢直播錄製路數、轉封裝用量。 |
| DescribeLiveDomainSnapshotData | 查詢直播域名截圖張數資料 | 呼叫 DescribeLiveDomainSnapshotData 查詢直播域名截圖張數。 |
| DescribeLiveDetectPornData | 查詢直播審核用量資料 | 調用DescribeLiveDetectPornData擷取查詢直播審核用量資料。 |
| DescribeDomainUsageData | 查詢網域名稱在特定計費地區的用量資料 | 調用DescribeDomainUsageData查詢網域名稱在特定計費地區的用量資料。 |
| DescribeLivePushProxyUsageData | 查詢直播中心轉推用量資料 | 呼叫 DescribeLivePushProxyUsageData 查詢直播中心轉推用量資料。 |
| DescribeLiveRealtimeDeliveryAcc | 查詢即時日誌投遞次數 | 呼叫 DescribeLiveRealtimeDeliveryAcc 查詢即時日誌投遞次數。 |
| DescribeLiveDomainTimeShiftData | 查詢直播時移用量資料 | 查詢直播時移用量資料。 |
| DescribeLiveDomainStreamTranscodeData | 查詢網域轉碼用量資料 | 呼叫 DescribeLiveDomainStreamTranscodeData 查詢網域轉碼用量資料。 |
| DescribeLiveProducerUsageData | 查詢導播台用量資料 | 呼叫 DescribeLiveProducerUsageData 查詢導播台用量資料。 |
| DescribeLiveDomainMonitoringUsageData | 取得域名廣目監播用量 | 呼叫 DescribeLiveDomainMonitoringUsageData 取得域名廣目監播用量資料。 |
| DescribeLiveDelayedStreamingUsage | 查詢延播時長資料 | 呼叫 DescribeLiveDelayedStreamingUsage 查詢延播時長用量資料。 |
| DescribeLiveGrtnDuration | 查詢連麥通話時長用量資料 | 呼叫 DescribeLiveGrtnDuration 查詢連麥通話時長用量資料。 |
| DescribeMeterLiveBypassDuration | 查詢混流轉碼用量資料 | DescribeMeterLiveBypassDuration |
| DescribeLiveDrmUsageData | 取得直播DRM用量資料 | 查詢指定時間範圍內DRM用量資料。 |
| DescribeLiveRtcRecordUsageData | 查詢即時音視頻雲端錄製用量 | 雲端錄製用量查詢。 |
雲端導播
|
API |
標題 |
API概述 |
| 導播台管理 | 導播台管理 | |
| CreateCaster | 建立導播台 | 調用CreateCaster建立導播台。 |
| SetCasterConfig | 設定導播台配置 | 調用本介面對導播台進行詳細配置,包括導播台的名稱、轉碼配置、錄製配置等參數資訊。 |
| DescribeCasterConfig | 查詢導播台配置 | 查詢導播台配置資訊。 |
| DescribeCasters | 查詢導播台列表 | 查詢導播台列表。 |
| DescribeCasterStreamUrl | 查詢導播台流資訊列表 | 查詢導播台流地址。 |
| CopyCaster | 複製導播台 | 複製導播台,複製指定導播台並返回新導播台執行個體。 |
| StartCaster | 啟動導播台 | 啟動導播台。若PVW、PGM情境不存在則建立,啟動PVW、PGM情境,啟動底層音視頻處理任務。 |
| StopCaster | 停止導播台 | 停止導播台。停止PVW(預覽情境)、PGM(正式輸出情境)情境。 |
| DeleteCaster | 刪除導播台 | 調用DeleteCaster刪除導播台。 |
| RestartCaster | 重啟導播台 | 調用RestartCaster重啟導播台。 |
| UpdateCasterResourceGroup | 更新導播台所在資源群組 | 調用UpdateCasterResourceGroup更新導播台所在資源群組。 |
| 輸入源媒體管理 | 輸入源媒體管理 | |
| AddCasterVideoResource | 添加導播台視頻資源 | 添加視頻源,視頻源數量受限於導播台輸入路數。 |
| DeleteCasterVideoResource | 刪除導播台視頻資源 | 刪除視頻資源。 |
| ModifyCasterVideoResource | 修改導播台視頻源 | 修改導播台視頻資源。 |
| DescribeCasterVideoResources | 查詢導播台視頻源 | 查詢導播台視頻源。 |
| 佈局管理 | 佈局管理 | |
| AddCasterLayout | 添加導播檯布局 | 添加導播檯布局。 |
| DeleteCasterLayout | 刪除導播檯布局資料 | 刪除布局資料。 |
| ModifyCasterLayout | 修改導播台佈局 | 修改佈局配置,傳遞修改項,非修改內容無需傳遞。 |
| DescribeCasterLayouts | 查詢導播檯布局列表 | 查詢導播檯布局列表。 |
| 元件管理 | 元件管理 | |
| 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概述 |
| 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概述 |
| GetMessageToken | 擷取長串連建連Token(舊版) | 調用GetMessageToken擷取長串連建連Token,用戶端可以用此Token通過LWP協議和各個原子能力進行長串連通訊。 |
| CreateMessageApp | 建立互動訊息應用(舊版) | 調用CreateMessageApp建立互動訊息應用。 |
| UpdateMessageApp | 更新互動訊息應用資訊(舊版) | 調用UpdateMessageApp更新互動訊息應用資訊。 |
| ListMessageApp | 查詢互動訊息應用程式列表(舊版) | 呼叫ListMessageApp查詢互動訊息應用程式列表。 |
| GetMessageApp | 擷取指定互動訊息應用詳情(舊版) | 調用GetMessageApp擷取指定互動訊息應用詳情。 |
| QueryMessageApp | 按指定條件查詢互動訊息應用(舊版) | 調用QueryMessageApp按指定條件查詢互動訊息應用。 |
| DeleteMessageApp | 刪除互動訊息應用程式(舊版) | 呼叫DeleteMessageApp刪除互動訊息應用程式。 |
| CreateMessageGroup | 建立訊息群組(舊版) | 呼叫CreateMessageGroup建立訊息群組。 |
| UpdateMessageGroup | 更新訊息群組(舊版) | 調用UpdateMessageGroup更新訊息群組資訊。 |
| ListMessageGroupUser | 查詢訊息群組成員(舊版) | 查詢訊息群組成員。 |
| ListMessageGroup | 查詢指定使用者下訊息群組(舊版) | 呼叫ListMessageGroup查詢指定使用者下訊息群組清單。 |
| GetMessageGroup | 取得訊息群組詳情(舊版) | 呼叫 GetMessageGroup 取得訊息群組詳情。 |
| JoinMessageGroup | 加入訊息群組(舊版) | 加入訊息群組。 |
| MuteAllGroupUser | 禁言訊息群組全員(舊版) | 調用MuteAllGroupUser對訊息群組禁言,即開啟全員禁言。 |
| MuteGroupUser | 批次禁言訊息群組內成員(舊版) | 調用MuteGroupUser批次禁言訊息群組內成員。 |
| CancelMuteGroupUser | 批次取消訊息群組內禁言成員(舊版) | 呼叫CancelMuteGroupUser批次取消訊息群組內禁言成員。 |
| CancelMuteAllGroupUser | 取消訊息組使用者的靜音(舊版) | 取消訊息組使用者的靜音。 |
| LeaveMessageGroup | 退出訊息群組(舊版) | 調用LeaveMessageGroup使用者退出訊息群組。 |
| SendLike | 設定按讚訊息(舊版) | 呼叫 SendLike 設定系統按讚訊息。 |
| SendMessageToGroup | 向訊息群組全員傳送訊息(舊版) | 呼叫SendMessageToGroup向訊息群組全員傳送訊息。 |
| SendMessageToGroupUsers | 向訊息群組內指定使用者傳送訊息(舊版) | 調用SendMessageToGroupUsers向訊息群組內指定使用者傳送訊息。 |
| ListMessage | 查詢訊息列表(舊版) | 查詢訊息列表。 |
| ListMessageGroupUserById | 透過使用者ID查詢使用者資訊(舊版) | 呼叫ListMessageGroupUserById透過使用者ID列表查詢使用者資訊。 |
| BatchGetOnlineUsers | 查詢使用者是否線上(舊版) | 根據一個或多個使用者uid查詢使用者是否線上 |
| ListMuteGroupUser | 查詢被禁言的訊息群組成員(舊版) | 呼叫ListMuteGroupUser查詢被禁言的訊息群組成員清單。 |
互動訊息伺服器端介面
|
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 | 發送訊息給指定使用者 | 發送訊息給指定使用者,使用者身份由ReceiverId標識。 |
| ListLiveMessageApps | 查詢直播互動應用列表 | 調用ListLiveMessageApps查詢互動訊息應用列表。 |
| DescribeLiveMessageApp | 查詢直播互動應用資訊 | 調用DescribeLiveMessageApp查詢互動訊息應用資訊。 |
| ModifyLiveMessageAppDisable | 修改直播互動應用禁用資訊 | 修改App禁用。 |
| ModifyLiveMessageAppAudit | 修改直播互動應用鑒權資訊 | 修改互動訊息應用安全性稽核設定。 |
| ModifyLiveMessageAppCallback | 修改直播互動應用回調資訊 | 修改互動訊息應用回調資訊。 |
| KickLiveMessageGroupUser | 將指定使用者從群組中踢出去 | 踢出互動訊息群組使用者。 |
| ModifyLiveMessageUserInfo | 修改使用者資訊 | 修改使用者資訊。 |
互動訊息(新)
|
API |
標題 |
API概述 |
| 雲端錄製 | 雲端錄製 | |
| StartRtcCloudRecording | 啟動 Rtc 雲端錄製任務 | 啟動 RTC 雲端錄製任務。 |
| UpdateRtcCloudRecording | 更新 Rtc 雲端錄製任務 | 更新 RTC 雲端錄製任務。 |
| StopRtcCloudRecording | 停止Rtc雲端錄製任務 | 停止rtc雲端錄製任務。 |
| DescribeRtcCloudRecordingFiles | 查詢 RTC 雲端錄製檔案及任務狀態 | 查詢 RTC 雲端錄製檔案與任務資訊。 |
| 頻道管理 | 頻道管理 | |
| DescribeChannelParticipants | 查詢頻道內線上使用者列表 | 查詢頻道內線上使用者列表。 |
| DescribeChannelUsers | 查詢頻道內線上使用者列表 | 查詢頻道內線上使用者列表的詳細資料。 |
| RemoveTerminals | 從頻道中踢出指定終端使用者 | 從頻道中踢出指定終端使用者。 |
| CreateRTCWhipStreamAddress | 建立RTC頻道WHIP推流地址 | 調用CreateRTCWhipStreamAddress建立RTC頻道WHIP推流地址 |
| CreateRoomRealTimeStreamAddress | 建立RTMP流在房間中的推流地址 | 建立RTMP流在房間中的推流地址。 |
| ListRTCLiveRooms | 查詢ARTC線上頻道列表 | 擷取線上頻道列表 |
| 旁路轉推 | 旁路轉推 | |
| StartLiveMPUTask | 建立混流轉推任務(新) | 建立混流轉推任務。 |
| UpdateLiveMPUTask | 更新混流轉推任務(新) | 更新混流轉推任務。 |
| StopLiveMPUTask | 停止混流轉推任務(新) | 停止混流轉推任務。 |
| ListRtcMPUTaskDetail | 查詢混流轉推任務參數明細 | 查詢混流轉推任務參數明細。 |
| SetLiveMpuTaskSei | 設定自訂SEI | 設定連麥旁路自訂sei。 |
| 事件回調 | 事件回調 | |
| CreateEventSub | 建立訂閱房間訊息回調 | 建立訂閱房間訊息的回調。 |
| ListEventSub | 查詢訂閱房間訊息列表 | 查詢訂閱房間訊息列表。 |
| ListEventSubEvent | 查詢回調記錄 | 查詢回調記錄。 |
| UpdateEventSub | 更新訂閱房間訊息回調 | 更新訂閱房間訊息回調。 |
| DeleteEventSub | 刪除訂閱房間訊息回調 | 刪除訂閱房間訊息的回調。 |
| CreateRtcMPUEventSub | 建立混流轉推事件訂閱。 | 建立混流轉推事件訂閱。 |
| UpdateRtcMPUEventSub | 更新混流轉推事件訂閱 | 更新混流轉推事件訂閱。 |
| DeleteRtcMPUEventSub | 刪除混流轉推事件訂閱 | 刪除混流轉推事件訂閱。 |
| DescribeRtcMPUEventSub | 查詢混流轉推事件訂閱 | 查詢混流轉推事件訂閱。 |
| ListRtcMPUEventSubRecord | 查詢混流轉推事件訂閱記錄 | 查詢混流轉推事件訂閱記錄。 |
| 品質資料 | 品質資料 | |
| DescribeLiveInteractionMetricData | 查詢即時音視頻指標資料 | 調用DescribeLiveInteractionMetricData查詢即時音視頻指標資料。 |
即時音影片
|
API |
標題 |
API概述 |
| DeleteLiveAIProduceRules | 刪除字幕規則 | 刪除字幕規則。 |
| DescribeLiveAIProduceRules | 查詢字幕規則 | 查詢字幕規則列表。 |
| UpdateLiveAIProduceRules | 更新即時字幕規則 | 更新字幕規則。 |
| AddLiveAIProduceRules | 添加即時字幕規則 | 添加字幕規則。 |
| AddLiveAISubtitle | 添加直播字幕範本 | 呼叫 AddLiveAISubtitle 添加字幕範本。 |
| DeleteLiveAISubtitle | 刪除字幕模板 | 調用DeleteLiveAISubtitle刪除指定字幕模板。 |
| UpdateLiveAISubtitle | 更新字幕範本 | 呼叫 UpdateLiveAISubtitle 更新字幕範本。 |
| DescribeLiveAISubtitle | 查詢字幕模板 | 調用DescribeLiveAISubtitle查詢字幕模板列表。 |
即時字幕
|
API |
標題 |
API概述 |
| CreateLiveAIStudio | 建立虛擬演播範本 | 本介面用於建立輕量化虛擬演播範本。 |
| DeleteLiveAIStudio | 刪除虛擬演播模板 | 刪除虛擬演播模板。 |
| ModifyLiveAIStudio | 修改虛擬演播範本 | 本介面用於修改指定的虛擬演播範本。 |
| DescribeLiveAIStudio | 查詢虛擬演播模板 | 查詢使用者帳號下的虛擬演播模板。 |
虛擬背景
|
API |
標題 |
API概述 |
| CreateLivePullToPush | 建立拉流轉推任務 | 呼叫CreateLivePullToPush建立拉流轉推任務。 |
| UpdateLivePullToPush | 更新拉流轉推任務 | 呼叫 UpdateLivePullToPush 更新拉流轉推任務。 |
| DeleteLivePullToPush | 刪除拉流轉推任務 | 呼叫 DeleteLivePullToPush 刪除拉流轉推任務。 |
| DescribeLivePullToPush | 查詢拉流轉推任務 | 呼叫 DescribeLivePullToPush 查詢拉流轉推任務。 |
| DescribeLivePullToPushList | 模糊查詢拉轉推任務 | 模糊查詢拉流轉推任務。 |
| StopLivePullToPush | 停止拉流轉推任務 | 停止任務介面。 |
| RestartLivePullToPush | 重啟拉流轉推任務 | 重啟任務介面。 |
拉流轉推
|
API |
標題 |
API概述 |
| SetLiveDomainMultiStreamConfig | 設定雙流災備開關 | 呼叫 SetLiveDomainMultiStreamConfig 設定開啟雙流災備開關。 |
| SetLiveDomainMultiStreamOptimalMode | 設定雙流災備自動模式開關 | 設定雙流災備自動模式開關。 |
| SetLiveDomainMultiStreamMaster | 手動切換雙流災備主流 | 手動切換雙流災備主流。 |
| DescribeLiveDomainMultiStreamConfig | 查詢雙流災備配置狀態 | 查詢雙流災備配置狀態。 |
| QueryLiveDomainMultiStreamList | 查詢雙流災備線上記錄 | 查詢雙流災備線上記錄。 |
雙流災備
|
API |
標題 |
API概述 |
| DescribeLiveDomainStagingConfig | 查詢灰階環境配置資訊 | 調用DescribeLiveDomainStagingConfig查詢灰階環境配置資訊。 |
| PublishLiveStagingConfigToProduction | 將灰階配置轉為生產配置 | 調用PublishLiveStagingConfigToProduction將灰階配置轉為生產配置。 |
| RollbackLiveStagingConfig | 將灰階環境配置復原 | 調用RollbackLiveStagingConfig將灰階環境配置復原。 |
| SetLiveDomainStagingConfig | 設定或修改灰階環境下的網域名稱配置 | 調用SetLiveDomainStagingConfig設定或修改灰階環境下的網域名稱配置。 |
| DeleteLiveSpecificStagingConfig | 刪除灰階環境下的網域名稱配置 | 調用 DeleteLiveSpecificStagingConfig 刪除灰階環境下的網域名稱配置。 |
邊緣指令碼
|
API |
標題 |
API概述 |
| DescribeLiveIpInfo | 擷取直播IP資訊 | 調用DescribeLiveIpInfo驗證指定IP是否為CDN節點的IP地址。 |
| DescribeLiveStreamAuthChecking | 查詢流鑒權 | 查詢當前線上流的鑒權。 |
工具箱
|
API |
標題 |
API概述 |
| TagLiveResources | 新增 Live 資源標籤 | 呼叫 TagLiveResources 新增 Live 資源標籤。 |
| UnTagLiveResources | 刪除Live資源標籤 | 呼叫UnTagLiveResources刪除Live資源標籤。 |
| ListLiveTagResources | 查詢符合條件的資源和標籤 | 查詢符合條件的資源和標籤。 |
| DescribeLiveTagResources | 查詢Live資源對應的標籤 | 用於查詢Live資源對應的標籤。 |
標籤管理
|
API |
標題 |
API概述 |
| AddLiveCenterTransfer | 新增直播中心轉推配置 | 新增直播中心轉推配置。 |
| CreateRtcAsrTask | 建立即時語音轉文字或翻譯 | 建立一個新的即時字幕任務,用於即時轉錄音訊串流為文字。 |
| DeleteChannel | 關閉頻道 | 關閉頻道將使所有目前通道內的成員退出,但不影響後續重新使用該頻道。 |
| DeleteLiveCenterTransfer | 刪除直播中心轉推 | 調用DeleteLiveCenterTransfer刪除直播中心轉推配置。 |
| DeleteLiveEdgeTransfer | 刪除直播轉推設定 | 刪除直播轉推設定。 |
| DeleteRtcAsrTask | 刪除即時語音轉文字或翻譯任務 | 調用DeleteRtcAsrTask刪除即時語音轉文字或翻譯任務。 |
| DescribeDomainWithIntegrity | 擷取網域名稱完整性 | 調用介面擷取網域名稱完整性 |
| DescribeLiveCenterTransfer | 取得直播中心轉推 | 呼叫DescribeLiveCenterTransfer查詢直播中心轉推配置。 |
| DescribeLiveEdgeTransfer | 查詢直播轉推配置 | 調用DescribeLiveEdgeTransfer查詢直播轉推配置。 |
| DescribeLiveRealtimeLogAuthorized | 查詢使用者即時日誌投遞授權狀態 | 查詢使用者即時日誌投遞授權狀態。 |
| DescribeLiveUserBillPrediction | 擷取直播使用者預期賬單 | 擷取直播使用者預期賬單 |
| DescribeRTSNativeSDKFirstFrameCost | 查詢首幀延遲組成 | 取得某一段時間內,首幀延遲組成。 |
| DescribeRTSNativeSDKFirstFrameDelay | 查詢首幀延遲 | 取得某一段時間內,首幀延遲(平均值)。 |
| DescribeRTSNativeSDKPlayFailStatus | 查詢播放失敗的原因 | 獲取某一段時間內,查詢播放失敗的原因(狀態碼形式)。 |
| DescribeRTSNativeSDKPlayTime | 查詢播放時長 | 取得某一段時間內的播放時長。 |
| DescribeRTSNativeSDKVvData | 查詢播放次數 | 取得某一段時間內播放次數,含總次數和成功次數。 |
| DescribeRtcCloudTranscode | 查詢雲端轉碼任務 | 查詢雲端轉碼任務。 |
| DescribeToutiaoLivePlay | 頭條拉流查詢介面 | 擷取頭條指定直播流的拉流資訊 |
| DescribeToutiaoLivePublish | 頭條推流查詢介面 | 擷取頭條指定直播流的推流資訊 |
| DescribeUpBpsPeakData | 查詢使用者的每日上行頻寬峰值 | 查詢使用者的每日上行頻寬峰值。 |
| DescribeUpBpsPeakOfLine | 查詢使用者的每日某種專線上行頻寬峰值 | 查詢使用者的每日某種專線上行頻寬峰值。 |
| DescribeUpPeakPublishStreamData | 查詢使用者的每日上行並行推流數峰值 | 查詢使用者的每日上行並行推流數峰值。 |
| QueryRtcAsrTasks | 查詢即時語音轉文字或翻譯 | 查詢當前已建立的即時語音轉文字或翻譯任務的狀態資訊。 |
| SetLiveEdgeTransfer | 設定直播轉推配置 | 呼叫 SetLiveEdgeTransfer 設定直播轉推配置。 |
| StartRtcCloudTranscode | 建立雲端轉碼任務 | 建立雲端轉碼任務。 |
| StopRtcAsrTask | 停止即時語音轉文字或翻譯 | 調用StopRtcAsrTask停止即時字幕任務。 |
| StopRtcCloudTranscode | 停止雲端轉碼任務 | 停止雲端轉碼任務。 |
| UpdateLiveCenterTransfer | 修改直播中心轉推配置 | 呼叫 UpdateLiveCenterTransfer 修改直播中心轉推配置。 |
其他
|
API |
標題 |
API概述 |
| 中心轉推 | 中心轉推 | |
| 即時語音轉文字/翻譯 | 即時語音轉文字/翻譯 | |
| 邊緣轉推 | 邊緣轉推 |