API標準及多語言預置SDK
本產品(ICE/2020-11-09)的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概述 |
| CreateUploadMedia | 擷取媒資上傳地址和憑證 | 本介面支援擷取音視頻、圖片和輔助媒資的上傳地址和憑證。並建立媒資資訊。 |
| CreateUploadStream | 擷取媒體流上傳地址和憑證 | 擷取媒體流上傳地址和憑證,並將上傳完成的媒體流掛載到指定的MediaId下。 |
| RefreshUploadMedia | 重新整理媒資上傳憑證 | 本介面用於媒資檔案上傳逾時後重新擷取媒資上傳憑證,也可用於媒資檔案的覆蓋上傳(即擷取到源檔案上傳地址後重新上傳且音/視頻ID保持不變)。 |
| RegisterMediaStream | 註冊媒體流 | 該介面用於將OSS上媒體流檔案註冊到媒體服務,並將該媒體流掛在到指定的MediaId下。 |
| GetUrlUploadInfos | 擷取URL上傳資訊 | 調用GetURLUploadInfos擷取URL上傳資訊,適用於通過URL上傳檔案的情境,用於查詢上傳任務的詳細資料。 |
| UploadMediaByURL | URL拉取上傳 | 調用UploadMediaByURL基於源檔案URL,拉取音視頻媒體檔案進行上傳,支援批量上傳。本介面主要適用於檔案沒有儲存在本機伺服器或終端,需要通過公網訪問的URL地址上傳的情境。 |
| UploadStreamByURL | 媒體流URL拉取上傳 | 調用UploadStreamByURL基於源檔案URL,拉取媒體流檔案並上傳至VOD點播儲存中。上傳完成後,該媒體流將自動掛載到指定的MediaId下。 |
媒資管理
|
API |
標題 |
API概述 |
| 媒資搜尋 | 媒資搜尋 | |
| 串流媒資操作 | 串流媒資操作 | |
| CloseStreamToSearchLib | 關閉流媒資 | 關閉流媒資,關閉後停止打標和分析。 |
| GetStreamTagList | 擷取流媒資打標 | 查詢流媒資打標資訊。 |
| CreateStreamToSearchLib | 建立流媒資 | 建立流媒資,把直播流註冊為媒資。 |
| AddStreamTagToSearchLib | 添加流媒資標籤 | 針對流媒資進行打標。 |
| 搜尋庫管理 | 搜尋庫管理 | |
| CreateSearchLib | 建立搜尋庫 | 使用者建立搜尋媒資庫。可以用來儲存媒資。 |
| QuerySearchLib | 查詢搜尋庫 | 查詢搜尋媒資庫資訊。 |
| ListSearchLib | 擷取搜尋庫列表 | 擷取搜尋庫列表資訊。 |
| AlterSearchLib | 修改搜尋庫 | 修改搜尋庫。 |
| DropSearchLib | 刪除搜尋庫 | 刪除搜尋媒資庫。刪除庫下所有媒資。 |
| 搜尋索引設定管理 | 搜尋索引設定管理 | |
| CreateSearchIndex | 建立搜尋索引 | 可以在搜尋庫下新增搜尋索引。一個搜尋庫下可以有多個不同類型搜尋索引。 |
| AlterSearchIndex | 修改搜尋索引 | 修改搜尋索引資訊(索引狀態或索引配置)。 |
| QuerySearchIndex | 查詢搜尋索引 | 查詢搜尋索引詳細資料。 |
| DropSearchIndex | 刪除搜尋索引 | 刪除索引,刪除後對應索引存量資料會被刪除,新增媒資也不再支援對應索引分析、儲存、搜尋。 |
| 搜尋索引任務管理 | 搜尋索引任務管理 | |
| QueryMediaIndexJob | 查詢媒資索引任務 | 查詢媒資對應開啟的索引任務。 |
| SearchIndexJobRerun | 搜尋索引任務重跑 | 批量重新分析指定媒資的搜尋索引任務。每次請求最多可以重跑20個媒資的索引任務。 |
| 媒資操作 | 媒資操作 | |
| InsertMediaToSearchLib | 插入媒資到搜尋庫 | 插入媒資到搜尋庫。 |
| UpdateMediaToSearchLib | 更新媒資到搜尋庫 | 在搜尋庫中更新媒資資訊。 |
| DeleteMediaFromSearchLib | 刪除媒資從搜尋庫 | 在搜尋庫中刪除指定媒資。 |
| 搜尋功能 | 搜尋功能 | |
| 基礎搜尋 | 基礎搜尋 | |
| SearchMedia | 搜尋媒體資訊 | 根據使用者所提供參數,返回合格媒資資訊。 |
| GetVideoList | 擷取媒資資訊列表 | 擷取視頻資訊列表。 |
| 人臉搜尋 | 人臉搜尋 | |
| SearchMediaByFace | 人臉圖片搜媒資 | 人臉圖片搜媒資介面(粗搜),輸入一張人臉圖片,搜尋該人物所在媒資的相關資訊。 |
| SearchMediaClipByFace | 人臉圖片搜媒資片段 | 人臉圖片搜媒資片段介面(精搜),基於粗搜結果返回該人臉所在媒資的相關人物片段資訊。 |
| 智慧標籤搜尋 | 智慧標籤搜尋 | |
| SearchMediaByAILabel | 智能標籤文本搜尋 | 可以根據人名、字幕、AI分類進行多模搜尋。 |
| 大型模型搜尋 | 大型模型搜尋 | |
| SearchMediaByMultimodal | 大模型搜尋 | 大模型搜尋。使用者可以使用自然語言描述進行搜尋。 |
| SearchMediaByHybrid | 混合搜尋 | 媒資混合搜尋。智能標籤文本搜尋和大模型搜尋能力合并進行多路召回,使用者可以使用自然語言描述進行搜尋。 |
| 媒資庫 | 媒資庫 | |
| RegisterMediaInfo | 註冊內容庫資源 | 發起一個註冊媒資的任務,賦予新媒資一個IMS的mediaId。介面根據InputURL,非同步呼叫其他媒資資訊服務,擷取媒資的檔案資訊。同時使用者可以設定一些基本資料的值,如標題、標籤、描述等。介面同步返回mediaId,使用者可以調用擷取媒資內容資訊GetMediaInfo的介面,擷取具體的媒資資訊。當前僅支援InputURL為OSS檔案或VOD媒資。 |
| GetMediaInfo | 擷取媒資內容資訊 | 根據IMS mediaId或媒資InputURL,擷取並返回媒資資訊。 |
| UpdateMediaInfo | 更新媒體資訊 | 根據IMS mediaId或媒資InputURL,更新一個媒資的媒資資訊。 |
| DeleteMediaInfos | 刪除媒資內容 | 大量刪除媒資資訊,最多一次刪20個。MediaIds不為空白時,優先使用MediaIds。如果MediaIds為空白,則InputURLs必須非空。 |
| BatchGetMediaInfos | 批量擷取媒體資訊 | 批量擷取媒資資訊,支援傳入多個mediaId。 |
| ListMediaBasicInfos | 列出媒資基礎資訊 | 根據使用者所給參數,返回所有合格媒資的基礎資訊。 |
| ListPublicMediaBasicInfos | 列出公用素材庫媒資基礎資訊 | 列出合格公用素材庫媒資基礎資訊,最多篩選出100條。 |
| ListAllPublicMediaTags | 列出公用素材庫所有標籤 | 列出公用素材庫媒資的所有標籤。 |
| SubmitMediaAiAnalysisJob | 提交媒資智能結構化分析任務 | 對媒資進行結構化分析,可以對視頻進行發言人分析、視頻翻譯、段落概要等分析。 |
| 分類管理 | 分類管理 | |
| GetCategories | 擷取分類及子分類 | 調用GetCategories擷取指定的分類資訊,及其子分類(即下一級分類)的列表。 |
| UpdateCategory | 更新分類 | 調用UpdateCategory更新媒資分類。 |
| 標記管理 | 標記管理 | |
| AddMediaMarks | 為媒資增加標記資訊 | 本介面用於為媒體資源(如視頻、音頻檔案)委任標記資訊,便於後續的檢索、分析及管理。 |
| GetMediaMarks | 按照點位ID擷取媒資標記資訊 | 該介面允許使用者根據指定的點位ID來查詢和擷取相應的媒體資源標記資訊。 |
| UpdateMediaMarks | 修改媒資標記資訊 | 修改媒資標記資訊。 |
| DeleteMediaMarks | 刪除媒資的標記資訊 | 刪除媒資的標記資訊。 |
| ListMediaMarks | 列出媒資的全部標記資訊 | 列出媒資的全部標記資訊。 |
| IPC 管理 | IPC 管理 | |
| GetPlayInfo | 擷取音視頻播放地址 | 本介面通過音視頻ID直接擷取媒體檔案(可使用視訊和音頻)的播放地址。整合阿里雲播放器SDK(適用於URL播放方式)或第三方播放器後,可使用該地址進行音視頻播放。 |
| DeletePlayInfo | 刪除媒體流 | 調用本介面刪除媒體流(視頻流,音頻流)資訊。支援大量刪除媒體流資訊。 |
媒資審核
|
API |
標題 |
API概述 |
| CreateAudit | 人工審核 | 調用CreateAudit針對媒資提交人工審核。 |
| SubmitMediaCensorJob | 提交媒體審核作業 | 允許使用者想智能媒體服務提交一個媒體檔案的審核任務,該介面支援對視頻、音頻或映像內容進行自動化的審核,以檢測其中可能包含的違規、敏感或不適宜的內容。 |
| QueryMediaCensorJobDetail | 查詢媒體審核作業詳情 | 調用QueryMediaCensorJobDetail查詢媒體審核作業的詳細資料。 |
| QueryMediaCensorJobList | 查詢媒體審核作業列表 | 調用QueryMediaCensorJobList查詢媒體審核作業列表。 |
設定管理
|
API |
標題 |
API概述 |
| 範本管理 | 範本管理 | |
| GetSystemTemplate | 擷取系統模板資訊 | 擷取單個系統預置模板資訊。 |
| SetDefaultCustomTemplate | 設定預設自訂模板 | 本介面用於設定使用者自訂的點播ApsaraVideo for Media Processing預設範本。 |
| UpdateCustomTemplate | 修改使用者自訂模板資訊 | 修改ApsaraVideo for Media Processing使用者自訂模板資訊。 |
| ListSystemTemplates | 擷取系統模板列表 | 擷取ApsaraVideo for Media Processing系統預置模板列表。 |
| ListCustomTemplates | 擷取自訂模板列表 | 擷取使用者自訂點播ApsaraVideo for Media Processing模板列表。 |
媒體處理
|
API |
標題 |
API概述 |
| 轉碼介面 | 轉碼介面 | |
| SubmitMediaConvertJob | 提交媒體轉碼任務 | 提交ApsaraVideo for Media Processing任務 |
| GetMediaConvertJob | 查詢媒體轉碼任務 | 擷取 MediaConvert 任務詳情 |
| ListMediaConvertJobs | 查詢媒體轉碼工作清單 | 查詢 MediaConvertJob 列表 |
| SubmitTranscodeJob | 提交轉碼任務 | 使用者可以調用SubmitTranscodeJob介面,指定需要轉碼的源檔案、輸出格式以及相關參數,並提交視頻或音頻檔案的轉碼任務到智能媒體服務。 |
| GetTranscodeJob | 查詢轉碼任務 | 查詢單個轉碼任務詳情。 |
| ListTranscodeJobs | 查詢轉碼工作清單 | 查詢媒體檔案的轉碼工作清單。 |
| SubmitPackageJob | 提交打包任務 | 提交打包任務介面。 |
| GetPackageJob | 擷取單個打包任務資訊 | 擷取單個打包任務資訊。 |
| ListPackageJobs | 擷取打包工作清單 | 擷取打包工作清單。 |
| GenerateKMSDataKey | 建立KMS資料密鑰 | 產生一個隨機的KMS資料密鑰,用於對視頻進行標準加密轉碼。 |
| DecryptKMSDataKey | 解密KMS資料密鑰密文 | 解密KMS資料密鑰中的CiphertextBlob密文。 |
| 截圖介面 | 截圖介面 | |
| SubmitSnapshotJob | 提交截圖任務 | 本介面用於提交截圖任務。通過該介面,使用者可以指定媒體檔案的ID或URL,以及截圖的時間點和格式,系統將根據這些參數產生截圖並儲存到指定的位置。 |
| SubmitDynamicImageJob | 提交動圖任務 | 本介面用於提交產生生動影像的任務。 |
| GetSnapshotUrls | 擷取截圖任務輸出URL | 擷取截圖任務輸出圖片的可訪問URL。 |
| GetSnapshotJob | 查詢截圖任務詳細資料 | 查詢截圖任務詳細資料。 |
| GetDynamicImageJob | 查詢動圖任務詳細資料 | 查詢動圖任務詳細資料。 |
| ListSnapshotJobs | 擷取截圖工作清單 | 擷取截圖工作清單。 |
| ListDynamicImageJobs | 擷取動圖工作清單 | 擷取動圖工作清單。 |
| 媒體資訊介面 | 媒體資訊介面 | |
| SubmitSyncMediaInfoJob | 提交同步媒體資訊任務 | 調用SubmitSyncMediaInfoJob以同步模式提交媒體檔案進行媒體資訊分析。 |
| SubmitMediaInfoJob | 提交媒體資訊非同步任務 | 提交媒體資訊非同步任務。 |
| GetMediaInfoJob | 媒體資訊任務查詢 | 查詢媒體資訊。 |
| ListMediaInfoJobs | 查詢媒體資訊工作清單 | 查詢媒體資訊工作清單。 |
即時處理
|
API |
標題 |
API概述 |
| 即時媒體轉碼 | 即時媒體轉碼 | |
| CreateLiveTranscodeTemplate | 建立即時媒體轉碼範本 | 調用本介面建立即時轉碼範本,便於提交即時轉碼任務。 |
| GetLiveTranscodeTemplate | 取得單個即時媒體轉碼範本 | 呼叫 GetLiveTranscodeTemplate 取得單個即時轉碼範本。 |
| UpdateLiveTranscodeTemplate | 更新即時媒體轉碼範本 | 更新即時轉碼範本。 |
| DeleteLiveTranscodeTemplate | 刪除即時媒體轉碼範本 | 刪除即時轉碼範本。 |
| ListLiveTranscodeTemplates | 取得即時媒體轉碼範本列表 | 呼叫 ListLiveTranscodeTemplates 取得即時媒體轉碼範本列表。 |
| SubmitLiveTranscodeJob | 提交即時媒體轉碼任務 | 呼叫本介面提交即時轉碼任務。 |
| SendLiveTranscodeJobCommand | 傳送即時轉碼任務指令 | 傳送即時轉碼任務指令。 |
| GetLiveTranscodeJob | 獲取單個即時媒體轉碼任務 | 調用GetLiveTranscodeJob獲取單個即時轉碼任務。 |
| UpdateLiveTranscodeJob | 更新即時媒體轉碼任務 | 調用UpdateLiveTranscodeJob更新即時轉碼任務資訊。 |
| DeleteLiveTranscodeJob | 刪除即時媒體轉碼任務 | 刪除指定即時轉碼任務。 |
| ListLiveTranscodeJobs | 取得即時媒體轉碼任務列表 | 呼叫 ListLiveTranscodeJobs 取得即時媒體轉碼任務列表。 |
| 即時媒體錄製 | 即時媒體錄製 | |
| CreateLiveRecordTemplate | 建立即時錄製範本 | 呼叫CreateLiveRecordTemplate建立即時錄製範本,便於提交即時錄製任務。 |
| GetLiveRecordTemplate | 獲取即時錄製範本明細 | 調用GetLiveRecordTemplate獲取即時錄製範本明細或任務範本快照。 |
| UpdateLiveRecordTemplate | 更新即時錄製範本 | 調用UpdateLiveRecordTemplate更新即時錄製範本。 |
| DeleteLiveRecordTemplate | 刪除即時錄製範本 | 調用DeleteLiveRecordTemplate刪除即時錄製範本,不影響現有任務。 |
| ListLiveRecordTemplates | 取得即時錄製範本清單 | 呼叫ListLiveRecordTemplates取得即時錄製範本清單。 |
| SubmitLiveRecordJob | 提交即時錄製任務 | 呼叫 SubmitLiveRecordJob 提交即時錄製任務,對直播流進行錄製。 |
| GetLiveRecordJob | 取得即時錄製任務明細 | 調用GetLiveRecordJob取得單一即時錄製任務明細。 |
| DeleteLiveRecordFiles | 刪除即時錄製檔案 | 呼叫 DeleteLiveRecordFiles 刪除即時錄製檔案,可選擇只刪除記錄或同時刪除原始 OSS 檔案。 |
| ListLiveRecordJobs | 獲取實時錄製任務列表 | 呼叫ListLiveRecordJobs獲取實時錄製任務列表,可分頁獲取。 |
| ListLiveRecordFiles | 查詢所有錄製索引檔案 | 呼叫 ListLiveRecordFiles 查詢某個時間段內的所有錄製索引檔案。 |
| 即時媒體截圖 | 即時媒體截圖 | |
| CreateLiveSnapshotTemplate | 建立即時截圖範本 | 呼叫CreateLiveSnapshotTemplate建立即時截圖範本,範本便於建立截圖任務。 |
| GetLiveSnapshotTemplate | 獲取即時截圖範本 | 調用GetLiveSnapshotTemplate獲取單個即時截圖範本。 |
| UpdateLiveSnapshotTemplate | 更新即時截圖範本 | 更新即時截圖範本。 |
| DeleteLiveSnapshotTemplate | 刪除即時截圖範本 | 刪除即時截圖範本。 |
| ListLiveSnapshotTemplates | 取得即時截圖範本列表 | 調用ListLiveSnapshotTemplates取得即時截圖範本列表,可分頁取得。 |
| SubmitLiveSnapshotJob | 提交即時截圖任務 | 調用SubmitLiveSnapshotJob提交即時截圖任務。如果在推流中提交,則會自動非同步啟動任務,否則為未啟動狀態。 |
| SendLiveSnapshotJobCommand | 傳送即時截圖任務指令 | 傳送即時截圖任務指令。 |
| GetLiveSnapshotJob | 獲取即時截圖任務 | 調用GetLiveSnapshotJob獲取單個即時截圖任務。 |
| DeleteLiveSnapshotFiles | 刪除即時擷圖檔案 | 呼叫DeleteLiveSnapshotFiles刪除即時擷圖檔案,可選擇只刪除記錄或同時刪除原始OSS檔案。 |
| ListLiveSnapshotJobs | 取得即時截圖任務列表 | 呼叫 ListLiveSnapshotJobs 取得即時截圖任務列表,可分頁取得。 |
| ListLiveSnapshotFiles | 取得即時截圖檔案列表 | 呼叫 ListLiveSnapshotFiles 取得即時截圖檔案列表,可分頁取得。 |
生產製作
|
API |
標題 |
API概述 |
| 雲端剪輯工程管理 | 雲端剪輯工程管理 | |
| CreateEditingProject | 建立雲剪輯工程 | 建立雲剪輯工程,支援設定標題、描述、時間軸和工程封面等。 |
| GetEditingProject | 擷取單個雲剪輯工程 | 查詢單個雲剪輯工程的資訊。 |
| UpdateEditingProject | 修改雲剪輯工程 | 修改雲剪輯工程,支援修改標題、時間軸和封面等。 |
| DeleteEditingProjects | 刪除雲剪輯工程 | 刪除雲剪輯工程,支援大量刪除。 |
| ListEditingProjects | 列出合格剪輯工程 | 列出合格剪輯工程,支援根據工程建立時間篩選。 |
| AddEditingProjectMaterials | 增加剪輯工程關聯素材 | 將一個或多個素材添加到剪輯工程中。 |
| GetEditingProjectMaterials | 擷取剪輯工程關聯素材 | 擷取當前工程綁定的所有素材。 |
| DeleteEditingProjectMaterials | 刪除剪輯工程關聯素材 | 將一個或多個素材從剪輯工程中刪除。 |
| GetLiveEditingIndexFile | 擷取直播剪輯索引檔案 | 擷取直播流的索引檔案,用於控制台剪輯預覽。 |
| SubmitProjectExportJob | 提交工程匯出任務 | 提交工程匯出任務。 |
| GetProjectExportJob | 查詢工程匯出任務。 | 查詢工程匯出任務資訊。 |
| 剪輯製作 | 剪輯製作 | |
| SubmitMediaProducingJob | 提交剪輯合成作業 | SubmitMediaProducingJob介面主要用於提交一個媒體剪輯合成任務。當使用者需要對視頻或音頻素材進行剪輯、合成或其他形式的後期製作時,可以通過調用此API介面來實現自動化處理。 |
| GetMediaProducingJob | 查詢剪輯合成作業 | 擷取剪輯合成作業的詳細資料,包括剪輯合成任務的任務狀態、時間軸、模板及資料等。 |
| SubmitLiveEditingJob | 提交直播剪輯任務 | 直播剪輯指將一個或多個直播流區間合成為成品。提交直播剪輯任務後,任務將進入後台排隊,非同步執行。提交後可以調用查詢直播剪輯作業(GeLiveEditingJob )介面根據 jobId 來查詢作業狀態。 也可調用擷取媒資內容資訊(GetMediaInfo)介面根據 MediaId 來查詢產生媒資的資訊。 |
| GetLiveEditingJob | 查詢直播剪輯作業 | 擷取剪輯合成作業的詳細資料,具體包括剪輯合成任務的任務狀態、時間軸、模板及資料、輸出成品資源ID、儲存地址、時間長度、以及任務其他資訊等。 本介面僅支援查詢近一年的直播剪輯任務資料。 |
| SubmitBatchMediaProducingJob | 批量智能一鍵成片 | 將多個視頻、音頻、圖片素材進行智能混剪,一鍵批量合成視頻。 |
| GetBatchMediaProducingJob | 擷取批量智能一鍵成片任務資訊 | 擷取批量智能一鍵成片作業的詳細資料,包括作業的輸入參數、任務狀態、合成的媒資ID及URL。本介面僅支援查詢近一年的任務資料。 |
| SubmitSportsHighlightsJob | 提交體育集錦任務 | 輸入包含解說的體育賽事素材,自動產生體育賽事集錦視頻。 |
| SubmitScreenMediaHighlightsJob | 提交高燃混剪任務 | 輸入短劇等影視素材,自動識別高光片段,合成高燃成片。 |
| ListMediaProducingJobs | 列出合格剪輯合成任務 | 列出合格合成任務,可根據任務狀態、類型查詢。 |
| ListBatchMediaProducingJobs | 列出合格一鍵成片任務 | 列出合格一鍵成片任務,可以根據任務類型、狀態等條件查詢。 |
| 範本工廠 | 範本工廠 | |
| GetTemplateMaterials | 擷取模板素材地址 | 返回進階模板包中的素材地址,供進階模板編輯器使用,素材連結30分鐘到期。FileList為所需素材數組,不填則預設返回全部素材地址,最多返回400個。 |
| GetTemplateParams | 擷取模板參數資訊 | 擷取模板可替換素材參數資訊,包括參數名稱、素材預設值、素材封面。當前僅支援進階模板。 |
| 智慧任務 | 智慧任務 | |
| 熱詞管理 | 熱詞管理 | |
| DeleteHotwordLibrary | 刪除熱詞庫 | 根據提供的熱詞庫ID刪除指定的熱詞庫。 |
| GetHotwordLibrary | 查詢熱詞詞庫 | 查詢熱詞詞庫。 |
| ListHotwordLibraries | 查詢所有熱詞庫列表 | 擷取指定條件下的所有熱詞庫資訊。 |
| UpdateHotwordLibrary | 修改熱詞庫 | 用於更新指定熱詞庫的資訊,包括名稱、描述和熱詞列表。 |
| CreateHotwordLibrary | 建立熱詞庫 | 建立熱詞庫。 |
| 數位人訓練 | 數位人訓練 | |
| CreateAvatarTrainingJob | 建立和初始化數字人訓練任務 | 本介面用於建立數字人訓練任務,配置數字人基礎資訊與訓練所需要的素材資訊等。 |
| UpdateAvatarTrainingJob | 更新數字人訓練任務資訊 | 調用此介面能夠修改數字人訓練任務的資訊,包括: 1\. 修改基本資料; 2\. 在訓練失敗後,更新 Video、Transparent 等資訊後重新進行訓練。 |
| SubmitAvatarTrainingJob | 提交數字人訓練任務 | 調用此介面來正式提交數字人訓練任務: 1\. 首次提交訓練; 2\. 在訓練失敗後重新提交訓練。 |
| GetAvatarTrainingJob | 查詢數字人訓練任務的詳細資料 | 本介面用於查詢單個數字人任務的詳細資料。 |
| DeleteAvatarTrainingJob | 刪除數字人訓練任務 | 調用本介面可以刪除處於「初始化(草稿)」、「訓練失敗」狀態下的任務。 |
| ListAvatarTrainingJobs | 查詢數字人訓練工作清單 | 調用本介面可以查詢您名下的數字人訓練任務資訊列表。 |
| GetAvatar | 查詢數字人 | 調用本介面,可以查詢某個已經訓練成功的數字人的詳細資料。 |
| ListAvatars | 查詢數字人列表 | 調用本介面,可以查詢到您名下所有已經訓練成功的數字人資訊。 |
| 人聲複製 | 人聲複製 | |
| CreateCustomizedVoiceJob | 建立人聲複製任務(基礎版) | 建立人聲複製任務,用於初始化配置人聲複製任務的基礎資訊 |
| GetDemonstrationForCustomizedVoiceJob | 擷取需要朗讀的示範文本及音頻(基礎版) | 通過本介面來擷取訓練個人化人聲所需要朗讀的文本及樣本音頻。 |
| DetectAudioForCustomizedVoiceJob | 提交音頻檢測(基礎版) | 本介面用來檢測使用者的朗讀是否有明顯的發音錯誤、嘈雜的環境等。 雲端在進行完音頻檢測後,對於檢測合格的音頻會暫存在雲端,供後續訓練聲音時使用,請勿省略該步驟。 |
| SubmitCustomizedVoiceJob | 提交人聲複製任務(基礎版) | 提交基礎版本人聲複製任務。 |
| SubmitStandardCustomizedVoiceJob | 提交人聲複製任務(福士版) | 提交福士版本的人聲複製任務。調用此介面後,會同步返回 JobId,訓練過程為非同步過程。在訓練期間,您可以通過調用 GetCustomizedVoiceJob - 查詢人聲複製訓練任務介面來擷取當前任務是否完成或訓練狀態等資訊。 |
| GetCustomizedVoiceJob | 查詢人聲複製任務 | 查詢單個人聲複製任務。 |
| DeleteCustomizedVoiceJob | 刪除人聲複製任務 | 調用此介面可以刪除處於非“訓練中”與“訓練成功”的人聲複製任務。 |
| ListCustomizedVoiceJobs | 查詢人聲複製工作清單 | 列出目前使用者的所有人聲複製訓練任務。 |
| GetCustomizedVoice | 查詢個人化人聲 | 調用本介面可以查詢特定的個人化人聲資訊。 |
| UpdateCustomizedVoice | 更新個人化人聲資訊 | 調用此介面可以修改個人化人聲的資訊,目前僅支援修改樣本音頻媒資ID,以支援自我維護樣本音頻。 |
| ListCustomizedVoices | 查詢個人化人聲列表 | 列出目前使用者的所有的個人化人聲。 |
| SubmitASRJob | 提交ASR智能字幕任務 | 根據視頻語音提取時間起止點及對應文字資訊。 |
| SubmitAvatarVideoJob | 提交數字人渲染任務 | 以人聲音頻或文本作為輸入,渲染虛擬人視頻。 |
| SubmitAudioProduceJob | 提交智能語音任務 | 本介面用於將提供的常值內容轉換成高品質的語音音頻檔案。 |
| SubmitTextGenerateJob | 提交關鍵詞擴寫任務 | 根據提交的關鍵詞、字數、文案數,擴寫出營銷文案。由於中文的特殊性,輸出文案字數可能跟需求字數有出入。提交任務成功後,根據JobId調用GetSmartHandleJob介面擷取任務狀態和結果。 |
| SubmitVideoTranslationJob | 提交視頻翻譯任務 | 通過本介面,您可以提交視頻翻譯任務。當前已支援字幕級翻譯(將視頻中出現的字幕翻譯為指定語言)、聲音(口播)級翻譯(將音頻中的口播內容翻譯為指定語言)與面容級翻譯(口型適配)。 |
| SubmitHighlightExtractionJob | 提交高光提取任務 | 提交高光提取任務。 |
| SubmitSegmentationJob | 提交拆條任務 | 將一個長視頻拆分成多個視頻片段,輸出多個視頻檔案或輸出為媒資。 |
| GetSmartHandleJob | 擷取智慧工作提示結果 | 擷取智慧工作提示結果,可以根據任務ID,擷取智慧工作提示資訊及執行結果。 本介面僅支援查詢近一年的剪輯任務資料。 |
| DeleteSmartJob | 刪除智慧工作提示 | 使用者可以根據任務ID刪除智慧工作提示。 |
| ListSmartJobs | 擷取工作清單 | 根據使用者所給參數,返回所有合格工作清單。 |
| ListSmartSysAvatarModels | 擷取系統數字人列表 | 擷取系統數字人列表,支援分頁查詢。 |
| ListSmartVoiceGroups | 列出智能語音發音人資訊 | 列出智能語音發音人資訊,包括髮音人名稱、性別、樣本音頻,列表按照情境進行分組。 |
AI 即時互動
|
API |
標題 |
API概述 |
| 智能體管理 | 智能體管理 | |
| StartAIAgentInstance | 啟動智能體執行個體 | 啟動一個IMS配置的AI智能體執行個體。 |
| StopAIAgentInstance | 停止智能體執行個體 | 停止一個智能體執行個體。 |
| UpdateAIAgentInstance | 更新AI智能體執行個體配置 | 修改指定AI智能體執行個體的配置資訊。 |
| DescribeAIAgentInstance | 查詢智能體執行個體詳情 | 查詢執行個體。 |
| ListAIAgentInstance | 查詢AI智能體執行個體列表 | 查詢AI智能體執行個體列表,可以擷取所有或指定條件下的智能體執行個體列表。 |
| GetAIAgentConcurrency | 擷取指定智能體當前的活躍通話並發數 | 擷取指定智能體當前的活躍通話並發數。這個介面是一個輕量查詢介面,返回的是“當前正在活躍中的執行個體數量”,不返回執行個體詳情,也不返回歷史峰值。 |
| SendAIAgentSpeech | 發送AI智能體語音 | 讓指定智能體執行個體立即播報簡訊,支援打斷設定。 |
| TakeoverAIAgentCall | 開啟真人接管模式 | 切換真人客服接管模式。 |
| SendAIAgentDataChannelMessage | 向智能體通話發送DataChannel訊息 | 向智能體通話發送DataChannel訊息。 |
| SendAIAgentText | 傳入訊息作為LLM輸入 | 傳入訊息作為LLM輸入。 |
| AICallKit 整合介面 | AICallKit 整合介面 | |
| GenerateMessageChatToken | 產生直播互動訊息所需的token | 產生直播互動訊息所需的token。 |
| GenerateAIAgentCall | 產生AI智能體通話執行個體 | 建立一個智能體執行個體,返回智能體所在的頻道、頻道內名稱以及進入頻道所需的token。 |
| ListAIAgentDialogues | 查詢對話記錄 | 列出會話的記錄。 |
| DeleteAIAgentDialogue | 刪除智能體的交談記錄 | 刪除智能體的交談記錄。 |
| SendMessageChatText | 向IM用戶端發送訊息 | 向IM用戶端發送訊息。 |
| 營運商線路介面 | 營運商線路介面 | |
| 聲紋管理 | 聲紋管理 | |
| SetAIAgentVoiceprint | 註冊人聲聲紋 | 設定聲紋 |
| ClearAIAgentVoiceprint | 清除聲紋 | 清除聲紋ID對應的聲紋 |
| ListAIAgentVoiceprints | 列出人聲聲紋 | 更新回調配置 |
| 離線任務 | 離線任務 | |
| SubmitAIAgentVideoAuditTask | 提交視頻送審任務 | 該介面是一個視頻送審服務,通過AI智能體對視頻內容進行審核,支援OSS輸入,允許使用者自訂視頻截幀策略和審核規則,並通過非同步回調的方式返回審核結果。 |
| RTOS License | RTOS License | |
| GetAiRtcAuthCodeList | 擷取AI即時互動授權碼資訊 | 查詢指定批次下的AI即時互動授權碼列表及狀態。 |
| ActiveAiRtcLicense | 啟用AI即時互動License | 根據批次ID、授權碼和裝置SN資訊啟用指定的License。 |
媒體 AI
|
API |
標題 |
API概述 |
| 智慧內容理解 | 智慧內容理解 | |
| 任務介面 | 任務介面 | |
| SubmitVideoCognitionJob | 提交視頻智能內容理解任務 | 提交視頻理解任務 |
| QueryVideoCognitionJob | 查詢智能內容理解任務 | 查詢視頻理解任務結果 |
| 自訂識別實體介面 | 自訂識別實體介面 | |
| CreateRecognitionEntity | 建立自訂識別庫中的待識別實體 | 在指定的自訂識別庫中建立一個新的待識別實體。通過該介面可以添加自訂地標、物體、台標、人物等識別實體。 |
| CreateRecognitionLib | 建立自訂識別庫 | 建立一個新的自訂識別庫,用於儲存待識別的實體資訊。 |
| CreateRecognitionSample | 註冊自訂實體的識別樣本 | 為指定的自訂實體添加識別樣本圖片或者文字標籤,用於後續的識別匹配。 |
| ListRecognitionSamples | 擷取自訂實體的識別樣本列表 | 分頁查詢指定實體下的所有識別樣本資訊。 |
| DeleteRecognitionSample | 刪除自訂實體的識別樣本 | 從指定的自訂實體中刪除一個識別樣本。 |
| ListRecognitionEntities | 擷取自訂識別庫中的實體列表 | 分頁查詢指定識別庫中的所有實體資訊。 |
| ListRecognitionLibs | 擷取自訂識別庫列表 | 分頁查詢目前使用者下的所有自訂識別庫資訊。 |
| DeleteRecognitionLib | 刪除自訂識別庫 | 刪除指定的自訂識別庫,包括庫中的所有實體和樣本資料。 |
| DeleteRecognitionEntity | 刪除自訂識別庫中的實體 | 從指定的自訂識別庫中刪除一個已存在的識別實體。 |
| 智慧生產 | 智慧生產 | |
| SubmitIProductionJob | 提交智能生產任務 | 調用SubmitIProductionJob提交智能生產任務。 |
| QueryIProductionJob | 查詢智能生產任務 | 調用QueryIProductionJob查詢智能生產任務狀態與結果。 |
| 媒體 DNA | 媒體 DNA | |
| CreateDNADB | 建立DNA庫 | 調用CreateDNADB建立DNA庫。 |
| DeleteDNADB | 刪除DNA庫 | 調用DeleteDNADB刪除DNA庫。 |
| ListDNADB | 查詢DNA庫 | 調用ListDNADB查詢DNA庫。 |
| SubmitDNAJob | 提交DNA作業 | 調用SubmitDNAJob提交DNA作業。 |
| CancelDNAJob | 取消DNA作業 | 調用CancelDNAJob取消DNA作業。 |
| DeleteDNAFiles | 刪除DNA檔案 | 調用DeleteDNAFiles刪除DNA檔案。 |
| ListDNAFiles | 查詢DNA檔案 | 調用ListDNAFiles查詢DNA檔案。 |
| QueryDNAJobList | 查詢DNA作業列表 | 調用QueryDNAJobList查詢DNA作業。 |
| 數位浮水印 | 數位浮水印 | |
| SubmitCopyrightJob | 提交視頻著作權浮水印作業 | 調用SubmitCopyrightJob提交視頻著作權浮水印任務。 |
| QueryCopyrightJobList | 查詢視頻著作權浮水印作業列表 | 查詢視頻著作權浮水印工作清單。 |
| SubmitCopyrightExtractJob | 提交著作權浮水印提取作業 | 提交著作權浮水印提取作業。 |
| QueryCopyrightExtractJob | 查詢著作權浮水印提取作業 | 查詢著作權浮水印提取任務。 |
| SubmitTraceAbJob | 提交視頻溯源浮水印ab流作業 | 提交視頻溯源浮水印ab流任務。 |
| QueryTraceAbJobList | 查詢視頻溯源浮水印ab流作業列表 | 查詢視頻溯源浮水印ab流工作清單。 |
| SubmitTraceM3u8Job | 提交視頻溯源浮水印m3u8作業 | 提交視頻溯源浮水印m3u8檔案任務。 |
| QueryTraceM3u8JobList | 查詢視頻溯源浮水印m3u8作業列表 | 查詢視頻溯源浮水印m3u8任務。 |
| SubmitTraceExtractJob | 提交溯源浮水印提取作業 | 提交溯源浮水印提取任務。 |
| QueryTraceExtractJob | 查詢溯源浮水印提取作業 | 查詢溯源浮水印提取任務。 |
用量統計
|
API |
標題 |
API概述 |
| DescribeMeterImsMediaConvertUHDUsage | IMS的MPS轉碼UHD計量查詢 | IMS的MPS轉碼UHD計量查詢,最大查詢範圍31天,最遠可查90天內的資料。 |
| DescribeMeterImsMediaConvertUsage | IMS的點播轉碼計量查詢 | IMS的點播轉碼計量查詢,最大查詢範圍31天,最遠可查90天內的資料。 |
| DescribeMeterImsEditUsage | IMS點播視訊剪輯用量查詢 | IMS點播視訊剪輯用量查詢,最大查詢範圍31天,最遠可查90天內的資料。 |
| DescribeMeterImsSummary | IMS點播用量統計查詢 | IMS點播用量統計查詢,最大查詢範圍31天,最遠可查90天內的資料。 |
| DescribeMeterImsMpsAiUsage | IMS的MPS-AI計量查詢 | IMS的MPS-AI用量查詢,最大查詢範圍31天,最遠可查90天內的資料。 |
全域設定
|
API |
標題 |
API概述 |
| SetEventCallback | 設定事件回調 | 設定特定事件的通知機制。 |
| GetEventCallback | 擷取事件回調 | 調用GetEventCallback擷取事件回調配置。 |
工作流程
|
API |
標題 |
API概述 |
| StartWorkflow | 提交工作流程工作 | 通過調用StartWorkflow介面,您可以提交工作流程範本任務,從而實現基於工作流程範本的自動化ApsaraVideo for Media Processing流程。 |
| GetWorkflowTask | 查詢工作流程工作 | 根據任務ID查詢工作流程工作,包括工作流程Id、工作流程工作狀態、工作流程工作結果。 本介面僅支援查詢近一年的工作流程工作資料。 |
| ListWorkflowTasks | 遍曆工作流程工作執行個體 | 遍曆工作流程工作執行個體。 |
| StartAIWorkflow | 提交智能工作流程工作 | 通過調用StartAIWorkflow介面,您可以提交智能工作流程工作,從而實現基於智能工作流程範本的自動化智能媒體服務流程。 |
| StopAIWorkflowTask | 停止智能工作流程工作 | 通過調用該介面,您可以主動停止智能工作流程工作。 |
| GetAIWorkflowTask | 查詢智能工作流程工作詳情 | 通過調用該介面,您可以查詢智能工作流程工作的詳細資料。 |
媒體服務
|
API |
標題 |
API概述 |
| 媒體直播 | 媒體直播 | |
| CreateMediaLiveInputSecurityGroup | 建立媒體直播輸入安全性群組 | 建立媒體直播輸入安全性群組。 |
| UpdateMediaLiveInputSecurityGroup | 更新媒體直播輸入安全性群組 | 更新媒體直播輸入安全性群組。 |
| GetMediaLiveInputSecurityGroup | 查詢媒體直播輸入安全性群組詳情 | 查詢媒體直播輸入安全性群組詳情。 |
| ListMediaLiveInputSecurityGroups | 查詢媒體直播輸入安全性群組列表 | 查詢媒體直播輸入安全性群組列表。 |
| DeleteMediaLiveInputSecurityGroup | 刪除媒體直播輸入安全性群組 | 刪除媒體直播輸入安全性群組。 |
| CreateMediaLiveInput | 建立媒體直播輸入 | 建立媒體直播輸入。 |
| UpdateMediaLiveInput | 更新媒體直播輸入 | 更新媒體直播輸入。 |
| GetMediaLiveInput | 查詢媒體直播輸入詳情 | 查詢媒體直播輸入詳情。 |
| ListMediaLiveInputs | 查詢媒體直播輸入列表 | 查詢媒體直播輸入列表。 |
| DeleteMediaLiveInput | 刪除媒體直播輸入 | 刪除媒體直播輸入。 |
| CreateMediaLiveChannel | 建立媒體直播頻道 | 建立媒體直播頻道。 |
| UpdateMediaLiveChannel | 更新媒體直播頻道 | 更新媒體直播頻道。 |
| GetMediaLiveChannel | 查詢媒體直播頻道詳情 | 查詢媒體直播頻道詳情。 |
| ListMediaLiveChannels | 查詢媒體直播頻道列表 | 查詢媒體直播頻道列表。 |
| DeleteMediaLiveChannel | 刪除媒體直播頻道 | 刪除媒體直播頻道。 |
| StartMediaLiveChannel | 啟動媒體直播頻道 | 啟動媒體直播頻道。 |
| StopMediaLiveChannel | 停止媒體直播頻道 | 停止媒體直播頻道。 |
| 媒體傳輸 | 媒體傳輸 | |
| GetMediaConnectAvailableRegion | 擷取MediaConnect所有可用的地區 | 擷取MediaConnect所有可用的地區 |
| ForbidMediaConnectFlowOutput | 禁用MediaConnect執行個體的某個輸出 | 禁用某個MediaConnect執行個體的某個輸出,禁用後該輸出配置仍保留,不再輸出直播流訊號。 |
| ResumeMediaConnectFlowOutput | 恢複MediaConnect執行個體的某個輸出 | 恢複某個MediaConnect執行個體的某個輸出,恢複後會正常輸出直播訊號。 |
| GetMediaConnectFlowAllOutputName | 擷取某個MediaConnect執行個體的所有輸出名稱 | 擷取某個MediaConnect執行個體下的所有output的名稱。 |
| CloseMediaConnectFlowFailover | 關閉MediaConnect輸入雙流災備 | 關閉某個MediaConnect執行個體的雙流災備功能。 |
| OpenMediaConnectFlowFailover | 開啟MediaConnect輸入雙流災備 | 對某個MediaConnect執行個體開啟輸入雙流災備。 |
| UpdateMediaConnectFlowOutput | 修改MediaConnect Flow執行個體的Output | 修改某個MediaConnect Flow執行個體的某個output。 |
| GetMediaConnectFlowOutput | 擷取MediaConnect Flow執行個體的Output資訊 | 根據outputName擷取某個output的詳細資料。 |
| DeleteMediaConnectFlowOutput | 刪除MediaConnect Flow執行個體的Output | 刪除某個MediaConnect Flow執行個體的某個output。 |
| AddMediaConnectFlowOutput | 為MediaConnect Flow執行個體建立Output | 為MediaConnect Flow執行個體建立output。 |
| DeleteMediaConnectFlowInput | 刪除MediaConnect Flow執行個體的Input | 刪除某個MediaConnect執行個體的input。 |
| UpdateMediaConnectFlowInput | 修改MediaConnect Flow執行個體的Input | 修改某個MediaConnect Flow執行個體的input。 |
| GetMediaConnectFlowInput | 擷取MediaConnect Flow執行個體的Input資訊 | 擷取MediaConnect執行個體下的input資訊。 |
| AddMediaConnectFlowInput | 為MediaConnect Flow執行個體建立Input | 為MediaConnect Flow執行個體建立Input。 |
| DeleteMediaConnectFlow | 刪除MediaConnect Flow執行個體 | 根據執行個體ID刪除MediaConnect執行個體。 |
| UpdateMediaConnectFlowStatus | 修改MediaConnect Flow執行個體的狀態 | 修改MediaConnect Flow執行個體的狀態。 |
| GetMediaConnectFlow | 擷取MediaConnect Flow執行個體的資訊 | 根據執行個體ID擷取對應MediaConnect Flow的詳細資料。 |
| CreateMediaConnectFlow | 建立MediaConnect Flow執行個體 | 建立一個MediaConnect Flow執行個體。 |
| 媒體廣告 | 媒體廣告 | |
| AddAdInsertion | 添加廣告插入配置 | 添加廣告插入配置。 |
| UpdateAdInsertion | 更新廣告插入配置 | 更新廣告插入配置。 |
| GetAdInsertion | 擷取廣告插入配置 | 擷取廣告插入配置。 |
| ListAdInsertions | 擷取廣告插入配置列表 | 擷取廣告插入配置列表。 |
| DeleteAdInsertion | 刪除廣告插入配置 | 刪除廣告插入配置。 |
| GetSourceLocation | 擷取頻道組裝源位置資訊 | 擷取源位置。 |
| UpdateSourceLocation | 更新頻道組裝源位置 | 更新源位置。 |
| DeleteSourceLocation | 刪除頻道組裝源位置 | 刪除源位置。 |
| ListSourceLocations | 列舉頻道組裝源位置 | 列舉源位置。 |
| CreateSourceLocation | 建立頻道組裝源位置 | 建立一個新的源位置。 |
| UpdateProgram | 更新頻道組裝節目 | 更新節目。 |
| GetProgram | 擷取頻道組裝節目 | 擷取節目。 |
| UpdateSource | 更新頻道組裝源資訊 | 更新源。 |
| StartChannel | 開啟頻道組裝頻道 | 啟動頻道。 |
| DeleteProgram | 刪除頻道組裝節目 | 刪除節目。 |
| StopChannel | 停止頻道組裝頻道 | 停止頻道。 |
| ListChannels | 列舉頻道組裝頻道 | 擷取頻道列表。 |
| ListPrograms | 列舉頻道組裝節目 | 擷取節目列表。 |
| CreateChannel | 建立頻道組裝頻道 | 建立一個新的頻道。 |
| ListSchedules | 列舉頻道組裝節目單 | 擷取節目單。 |
| ListSources | 列舉頻道組裝源資訊 | 列舉源。 |
| GetChannel | 擷取頻道組裝頻道 | 擷取頻道。 |
| CreateProgram | 建立頻道組裝節目 | 建立一個新的節目。 |
| ListChannelAlerts | 列舉頻道組裝頻道警告資訊 | 擷取頻道警告。 |
| UpdateChannel | 更新頻道組裝頻道 | 更新頻道。 |
| 媒體封裝 | 媒體封裝 | |
| 隨選視訊封裝 | 隨選視訊封裝 | |
| CreateVodPackagingGroup | 建立點播打包組 | 建立點播打包組。 |
| GetVodPackagingGroup | 查詢點播打包組 | 擷取點播打包組。 |
| ListVodPackagingGroups | 列舉點播打包組 | 列舉點播打包組。 |
| DeleteVodPackagingGroup | 刪除點播打包組 | 刪除點播打包組。 |
| CreateVodPackagingConfiguration | 建立點播打包配置 | 建立點播打包配置。 |
| GetVodPackagingConfiguration | 查詢點播打包配置 | 查詢打包模板配置。 |
| ListVodPackagingConfigurations | 列舉點播打包配置 | 列舉點播打包配置列表。 |
| DeleteVodPackagingConfiguration | 刪除點播打包配置 | 刪除點播打包配置。 |
| CreateVodPackagingAsset | 建立點播打包資產 | 建立vod打包資產。 |
| BatchCreateVodPackagingAsset | 大量建立點播打包資產 | 大量建立vod打包資產。 |
| GetVodPackagingAsset | 查詢點播打包資產 | 查詢點播打包資產。 |
| ListVodPackagingAssets | 列舉點播打包資產 | 列舉點播打包資產。 |
| DeleteVodPackagingAsset | 刪除點播打包資產 | 刪除點播打包資產。 |
| 直播封裝 | 直播封裝 | |
| CreateLivePackageChannelGroup | 建立即時打包頻道組 | 用於建立一個新的即時打包服務頻道組,支援自訂名稱與描述。 |
| UpdateLivePackageChannelGroup | 修改即時打包頻道組 | 更新即時打包服務中的頻道組資訊,包括描述。 |
| GetLivePackageChannelGroup | 擷取即時打包頻道組 | 通過頻道組名稱擷取即時打包頻道組的詳細資料。 |
| ListLivePackageChannelGroups | 查詢即時打包頻道組 | 分頁查詢即時打包服務中的頻道組資訊,支援按名稱或描述模糊搜尋及排序。 |
| DeleteLivePackageChannelGroup | 刪除即時打包頻道組 | 刪除指定名稱的即時打包頻道組。 |
| CreateLivePackageChannel | 建立即時打包頻道 | 產生即時視頻流處理頻道,支援HLS協議,自動分配端點和密鑰。 |
| UpdateLivePackageChannel | 修改即時打包頻道 | 更新即時打包服務中的頻道配置,包括協議、時間長度與切片數量等。 |
| UpdateLivePackageChannelCredentials | 更新頻道密鑰 | 即時打包服務API,用於重新整理指定頻道的輸入端點密鑰。 |
| GetLivePackageChannel | 擷取即時打包頻道 | 查詢指定頻道的即時打包配置詳情。 |
| ListLivePackageChannels | 查詢即時打包頻道 | 按頻道組與關鍵詞查詢即時打包頻道列表,支援分頁和排序。 |
| DeleteLivePackageChannel | 刪除即時打包頻道 | 根據GroupName和ChannelName刪除指定的即時打包頻道。 |
| CreateLivePackageOriginEndpoint | 建立即時打包來源站點端點 | 用於添加即時資料流媒體頻道的來源站點端點配置,支援HLS、HLS_CMAF和DASH協議及DRM加密。 |
| UpdateLivePackageOriginEndpoint | 修改即時打包來源站點端點 | 更新頻道組的即時打包來源站點端點配置,支援協議、時移設定及存取控制。 |
| GetLivePackageOriginEndpoint | 擷取即時打包來源站點端點 | 查詢指定頻道的即時資料流打包來源站點配置詳情。 |
| ListLivePackageOriginEndpoints | 查詢即時打包來源站點端點列表 | 按頻道組和頻道名稱查詢即時打包來源站點端點,支援分頁和排序。 |
| DeleteLivePackageOriginEndpoint | 刪除即時打包源端點 | 刪除指定頻道下的即時打包源端點配置。 |
萬鏡一刻
|
API |
標題 |
API概述 |
| RegisterYikeAssetMediaInfo | 註冊媒資資訊 | 註冊內容庫資源。 |
| ListYikeProductions | 擷取專案列表 | 擷取一刻專案列表 |
| GetYikeAssetMediaInfo | 擷取媒資資訊詳情 | 擷取媒資內容資訊。 |
| ListYikeAssetFolders | 擷取資料夾清單 | 擷取一刻資料夾清單。 |
| BatchGetYikeAssetMediaInfos | 批量擷取媒資資訊詳情 | 批量擷取媒資資訊。 |
| DeleteYikeAssetMediaInfos | 刪除媒資資訊詳情 | 刪除媒資資訊。 |
| ResumeYikeStoryboardJob | 恢複故事版執行狀態 | 故事板任務恢複繼續執行任務 |
| CreateYikeProduction | 建立專案 | 建立一刻專案 |
| CreateYikeWorkspace | 建立工作室 | 建立工作室 |
| CreateYikeUser | 添加使用者 | 建立一刻子使用者 |
| GetYikeUser | 擷取一刻使用者 | 擷取一刻子使用者資訊 |
| SetYikeUserRole | 設定使用者角色 | 設定使用者角色 |
| AddYikeUserCredit | 增加子帳號積分 | 增加使用者積分 |
| GetYikeUserCredit | 查詢子帳號積分 | 查詢一刻使用者積分 |
| SubYikeUserCredit | 扣減使用者積分 | 扣減使用者積分 |
| PrecheckYikeAIAppJob | 預校正應用任務參數 | 檢查應用參數是否合法 |
其他
|
API |
標題 |
API概述 |
| SubmitSmarttagJob | 提交智能標籤作業 | 提交智能標籤作業。 |
| QuerySmarttagJob | 智能標籤任務查詢介面 | 查詢智能標籤任務。 |
| 全集設定--deprecated | 全集設定--deprecated | |
| SetContentAnalyzeConfig | 設定智能內容分析配置 | 調用SetContentAnalyzeConfig 設定智能內容分析的配置。 |
| GetContentAnalyzeConfig | 擷取智能內容分析配置 | 調用GetContentAnalyzeConfig擷取智能內容分析的配置。 |
| SetDefaultStorageLocation | 設定預設儲存位置 | 設定臨時檔案的預設儲存路徑。預設儲存地址用於ICE線上編輯器及整合webSDK使用時,剪輯過程產生的臨時檔案儲存體,如智能配置產生的音頻檔案等;設定預設儲存地址,可避免在編輯過程中申請填寫各類臨時資源的儲存路徑時,對使用者造成困擾;如果通過API接入ICE剪輯能力,可在介面中靈活設定路徑,此預設路徑不生效。 |
| GetDefaultStorageLocation | 擷取預設儲存位置 | 本文為您介紹擷取預設儲存配置API請求參數及樣本。 |
| DescribePlayList | 播放記錄列表介面 | 通過播放器TraceId來擷取播放記錄列表,該介面有分頁。 |
| 素材中心 | 素材中心 | |
| AddFavoritePublicMedia | 收藏公用著作權媒資 | 根據輸入的mediaId 列表,將所有媒資加入收藏。 |
| CancelFavoritePublicMedia | 移除最愛公用著作權媒資 | 根據輸入的mediaId 列表,將所有媒資移除最愛。 |
| GetPublicMediaInfo | 擷取公用著作權媒資 | 根據ICE公用著作權媒資的 mediaId,擷取並返回媒資資訊。介面返回的URL為著作權媒資的試聽或試看地址,合成時會使用正式素材。 |
| SearchPublicMediaInfo | 搜尋公用著作權媒資 | 根據使用者所給參數,搜尋合格媒資。 |
| GetStorageList | 擷取OSS儲存地址清單 | 擷取儲存配置列表。 |
| SearchEditingProject | 搜尋雲剪輯工程 | 支援按建立時間、狀態搜尋。 |
| StopRtcRobotInstance | 停止RTC互動AI智能體執行個體 | 停止一個RTC互動AI智能體執行個體。 |
| StartRtcRobotInstance | 啟動RTC互動AI智能體執行個體 | 啟動一個RTC互動AI智能體執行個體,並加入RTC通話。 |
| UpdateRtcRobotInstance | 更新RTC互動AI智能體執行個體 | 修改一個RTC互動AI智能體執行個體配置,如音色、歡迎語等 |
| DescribeRtcRobotInstance | 查詢RTC互動AI智能體執行個體 | 查詢一個RTC互動AI智能體執行個體的資訊 |
| SetNotifyConfig | 設定智能體事件回調通知配置 | 啟用或禁用智能體事件通知,並配置回調URL與關注的事件類型。 |
| DescribeNotifyConfig | 查詢智能體通知配置 | 擷取指定智能體的事件回調設定。 |
| CancelIProductionJob | 取消智能生產任務 | 調用CancelIProductionJob取消智能生產任務。 |
| SubmitSceneMediaSelectionJob | 提交情境化素材挑選任務 | 根據傳入的視頻、圖片、口播等素材,挑選合適的素材片段,並返回挑選結果。支援兩種情境:智能匹配、高燃混剪。 |
| SubmitSceneBatchEditingJob | 提交情境化批量合成任務 | 輸入多個剪輯工程ID,批量提交時間軸合成,產生多個視頻。 |
| SubmitSceneTimelineOrganizationJob | 提交情境化時間軸編排任務 | 根據素材挑選結果,將視頻、圖片、背景音樂、口播等素材編排成完整時間軸,並建立剪輯工程以便預覽。支援兩種情境:智能匹配、高燃混剪。 |
| CreateCustomTemplate | 建立使用者自訂模板 | 本介面允許使用者建立自訂的ApsaraVideo for Media Processing模板。 |
| CreateSource | 建立頻道組裝源 | 建立一個新的源。 |
| DeleteChannel | 刪除頻道組裝頻道 | 刪除頻道。 |
| DeleteCustomTemplate | 刪除自訂模板 | 刪除使用者自訂模板。 |
| DeleteSource | 刪除頻道組裝源 | 刪除源。 |
| GetAiRtcLicenseInfoList | 擷取AI即時互動授權批次資訊 | 查詢指定條件下的AI即時互動授權批次詳情。 |
| GetCustomTemplate | 擷取自訂模板資訊 | 擷取ApsaraVideo for Media Processing使用者自訂模板資訊。 |
| GetSource | 擷取頻道組裝源資訊 | 擷取源。 |
| ListAlerts | 擷取頻道組裝警告資訊 | 擷取警告資訊。 |
| SubmitDynamicChartJob | 提交動態圖表任務 | 根據Excel產生折線圖、餅圖、柱狀圖等視頻,支援修改線條顏色、字型等資訊。 |
| CreatePipeline | 建立管道 | 本介面用於建立ApsaraVideo for Media Processing管道,實現媒體檔案的自動化和批量處理。 |
| DeletePipeline | 刪除使用者管道 | 刪除使用者管道資訊。 |
| GetPipeline | 擷取管道詳細資料 | 擷取使用者管道詳細資料。 |
| ListPipelines | 擷取管道列表 | 擷取使用者管道列表。 |
| UpdatePipeline | 更新管道資訊 | 更新使用者管道資訊。 |
| AddTemplate | 建立模板 | 智能生產製作支援基於普通模板和進階模板的視訊剪輯功能,使用者可調用AddTemplate建立模板。 |
| BatchGetYikeAIAppJob | 批量擷取AI應用任務 | 批量擷取一刻AI應用產生任務 |
| CreateYikeAssetUpload | 擷取音視頻上傳地址和憑證 | 擷取一刻媒資上傳憑證 |
| DeleteTemplate | 刪除模板 | 刪除模板。 |
| GetTemplate | 擷取模板資訊 | 根據模板ID擷取模板資訊。進階模板有解析過長,當類型為進階模板時,Status為Available時即可使用。 |
| GetYikeAIAppJob | 擷取任務結果詳情 | 擷取一刻AI應用任務。 |
| GetYikeStoryboardJob | 查詢故事板產生任務 | 擷取一刻AI應用任務 |
| ListTemplates | 列出合格模板 | 列出合格模板,支援根據模板狀態、建立來源等資訊查詢。 |
| SubmitYikeAIAppJob | 提交應用任務 | 提交一刻AI應用任務。 |
| SubmitYikeStoryboardJob | 提交故事板產生任務 | 提交一刻AI應用任務 |
| UpdateTemplate | 修改模板 | 調用UpdateTemplate介面修改雲剪輯模板,支援修改模板標題、模板配置等資訊。 |
| AddCategory | 建立分類 | 調用AddCategory建立媒資分類。 |
| DeleteCategory | 刪除分類 | 調用DeleteCategory刪除媒資分類。 |