API標準及多語言預置SDK
本產品（Mts/2014-06-18）的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概述 |
| SubmitMediaInfoJob | 提交媒體資訊作業 | 提交媒體資訊作業。調用本介面之後ApsaraVideo for Media Processing會對輸入檔案進行媒體資訊分析，返回輸入檔案的媒體資訊。 |
| QueryMediaInfoJobList | 查詢媒體資訊作業資訊 | 查詢媒體資訊作業。 |
轉碼介面
|
API |
標題 |
API概述 |
| SubmitJobs | 提交轉碼作業 | 提交轉碼作業。當控制台建立的轉碼任務和工作流程均無法滿足您的使用情境時，可以按需調用SubmitJobs介面進行轉碼。根據您的商務邏輯配置所需的轉碼參數即可。 |
| CancelJob | 取消轉碼作業 | 取消轉碼作業。 |
| QueryJobList | 查詢轉碼作業 | 透過轉碼作業 ID，批次查詢轉碼作業。 |
| ListJob | 遍曆轉碼作業 | 遍曆轉碼作業。 |
預置智慧範本推薦介面
|
API |
標題 |
API概述 |
| SubmitAnalysisJob | 提交預置模板分析作業 | 提交預置模板分析作業。 |
| QueryAnalysisJobList | 查詢範本分析作業 | 查詢範本分析作業，模板分析作業完成後，返回可用的預置模板列表。 |
自訂轉碼範本介面
|
API |
標題 |
API概述 |
| AddTemplate | 新增自訂轉碼模版 | 建立自訂模板，包含容器資訊，視頻跟音頻流等設定。 |
| UpdateTemplate | 更新自訂轉碼模版 | 更新自訂轉碼模板設定。 |
| QueryTemplateList | 通過自訂模版ID查詢轉碼模板詳情 | 查詢轉碼模板詳細資料。 |
| SearchTemplate | 搜尋自訂轉碼模板 | 搜尋指定狀態的自訂模板。 |
| DeleteTemplate | 刪除自訂轉碼模板 | 刪除自訂模板。 |
浮水印範本介面
|
API |
標題 |
API概述 |
| AddWaterMarkTemplate | 新增浮水印模版 | 建立浮水印模板。 |
| DeleteWaterMarkTemplate | 刪除浮水印模板 | 刪除浮水印模板。 |
| UpdateWaterMarkTemplate | 更新浮水印模版 | 更新指定浮水印模板的名稱、配置。 |
| SearchWaterMarkTemplate | 搜尋浮水印模板 | 搜尋浮水印模板。 |
| QueryWaterMarkTemplateList | 通過浮水印模板ID查詢浮水印模板詳情 | 查詢浮水印模板。 |
截圖介面
|
API |
標題 |
API概述 |
| SubmitSnapshotJob | 提交截圖作業 | 提交截圖作業。調用本介面之後ApsaraVideo for Media Processing會對輸入檔案進行截圖和拼圖。 |
| QuerySnapshotJobList | 查詢截圖作業結果 | 查詢截圖作業。 |
管道介面
|
API |
標題 |
API概述 |
| UpdatePipeline | 更新管道：名稱、狀態及通知設定 | 更新管道。 |
| QueryPipelineList | 查詢管道 | 通過管道ID查詢管道。 |
| SearchPipeline | 搜尋管道 | 通過管道狀態搜尋管道。 |
| AddPipeline | 添加管道 | 新增一個管道。 |
| DeletePipeline | 刪除管道 | 刪除管道。 |
媒體工作流程介面
|
API |
標題 |
API概述 |
| AddMediaWorkflow | 新增媒體工作流程 | 新增媒體工作流程。 |
| ActivateMediaWorkflow | 啟用媒體工作流程 | 啟用媒體工作流程。 |
| DeactivateMediaWorkflow | 停用媒體工作流程 | 停用媒體工作流程。 |
| DeleteMediaWorkflow | 刪除媒體工作流程 | 刪除媒體工作流程。 |
| UpdateMediaWorkflow | 更新媒體工作流程的拓撲結構 | 更新媒體工作流程。 |
| QueryMediaWorkflowList | 查詢登入媒體工作流程 | 查詢登入的媒體工作流程。 |
| SearchMediaWorkflow | 搜尋媒體工作流程 | 搜尋媒體工作流程。 |
| UpdateMediaWorkflowTriggerMode | 更新媒體工作流程的觸發模式狀態 | 更新媒體工作流程的觸發模式。 |
媒體工作流程執行個體介面
|
API |
標題 |
API概述 |
| QueryMediaWorkflowExecutionList | 查詢媒體工作流程執行執行個體 | 查詢媒體工作流程執行執行個體。 |
| ListMediaWorkflowExecutions | 遍曆媒體工作流程執行執行個體 | 遍曆媒體工作流程執行執行個體。 |
媒體Bucket介面
|
API |
標題 |
API概述 |
| BindInputBucket | 媒體庫綁定輸入Bucket | ApsaraVideo for Media Processing操作的檔案資源均存放在OSS的Bucket中。將OSS的Bucket在ApsaraVideo for Media Processing中綁定為輸入媒體Bucket、輸出媒體Bucket後，ApsaraVideo for Media Processing才有許可權監聽該Bucket上傳完成的訊息，以實現觸發工作流程執行和處理完成的檔案回寫動作。您可以調用BindInputBucket介面綁定輸入媒體Bucket。 |
| BindOutputBucket | 綁定輸出媒體Bucket | ApsaraVideo for Media Processing操作的檔案資源均存放在OSS的Bucket中。將OSS的Bucket在ApsaraVideo for Media Processing中綁定為輸入媒體Bucket、輸出媒體Bucket後，ApsaraVideo for Media Processing才有許可權監聽該Bucket上傳完成的訊息，以實現觸發工作流程執行和處理完成的檔案回寫動作。您可以調用BindOutputBucket介面綁定輸出媒體Bucket。 |
| UnbindInputBucket | 媒體庫解除綁定輸入Bucket | 解除綁定輸入媒體Bucket。 |
| UnbindOutputBucket | 解除綁定輸出Bucket | 解除綁定輸出媒體Bucket。 |
| ListAllMediaBucket | 查詢媒體Bucket | 列出媒體庫所有媒體Bucket。 |
媒體介面
|
API |
標題 |
API概述 |
| AddMedia | 新增媒體 | 提交新增媒體作業。 |
| DeleteMedia | 刪除媒體 | 刪除媒體。 |
| UpdateMedia | 更新媒體基本資料 | 更新媒體基本資料。 |
| UpdateMediaCategory | 更新媒體類目 | 更新媒體類目。 |
| UpdateMediaCover | 更新媒體封面 | 更新媒體封面。 |
| AddMediaTag | 新增媒體標籤 | 調用AddMediaTag介面為媒體檔案添加單個標籤。 |
| DeleteMediaTag | 更新媒體-刪除標籤 | 刪除媒體標籤。 |
| UpdateMediaPublishState | 更新媒體發布狀態 | 更新媒體發布狀態。 |
| QueryMediaList | 查詢媒體列表 | 使用媒體ID查詢媒體。 |
| QueryMediaListByURL | 通過媒體的輸入地址進行媒體資訊的查詢 | 使用OSS檔案地址查詢媒體。 |
智慧生產介面
|
API |
標題 |
API概述 |
| QueryIProductionJob | 查詢智能生產作業 | 查詢智能生產作業。 |
| SubmitIProductionJob | 提交智能生產作業 | 提交智能生產作業。 |
智慧標籤介面
|
API |
標題 |
API概述 |
| SubmitMediaCensorJob | 提交媒體審核作業 | 提交媒體審核作業。 |
| QueryMediaCensorJobDetail | 查詢媒體審核作業詳情 | 查詢媒體審核作業的詳細資料。 |
| QueryMediaCensorJobList | 查詢媒體審核作業列表 | 查詢媒體審核作業列表。 |
媒體審核介面
|
API |
標題 |
API概述 |
| SubmitFpShotJob | 提交DNA作業 | 查詢DNA底庫中是否存在相同或者相近的DNA結果。 |
| QueryFpShotJobList | 查詢DNA作業結果 | 查詢DNA作業結果，本介面支援查詢所有類型的DNA作業結果。 |
| CreateFpShotDB | 建立DNA庫 | 提交建立DNA庫作業。 |
| ListFpShotDB | 查詢DNA庫 | 查詢DNA庫。 |
| SubmitFpFileDeleteJob | 提交刪除DNA檔案 | 提交刪除DNA檔案作業。 |
| QueryFpFileDeleteJobList | 查詢刪除DNA檔案 | 查詢刪除DNA檔案作業。 |
| SubmitFpDBDeleteJob | 提交刪除DNA庫 | 提交刪除DNA庫作業。 |
| QueryFpDBDeleteJobList | 查詢清空或刪除DNA庫 | 查詢刪除DNA庫作業。 |
影片DNA介面
|
API |
標題 |
API概述 |
| QueryCopyrightExtractJob | 查詢版權浮水印擷取作業 | 呼叫此介面查詢版權浮水印擷取資訊作業。 |
| QueryCopyrightJob | 查詢影片版權浮水印作業 | 呼叫此介面查詢影片版權浮水印作業。 |
| QueryTraceAbJob | 查詢視訊溯源浮水印ab流作業 | 呼叫此介面查詢視訊溯源浮水印ab流作業。 |
| QueryTraceExtractJob | 查詢溯源浮水印擷取作業 | 調用此介面查詢溯源浮水印擷取作業資訊。 |
| QueryTraceM3u8Job | 查詢影片溯源浮水印 m3u8 作業 | 呼叫此介面查詢影片溯源浮水印 m3u8 作業。 |
| SubmitCopyrightExtractJob | 提交版權浮水印提取作業 | 調用此介面提交版權浮水印提取作業。 |
| SubmitCopyrightJob | 提交視頻版權浮水印作業 | 調用SubmitCopyrightJob提交視頻版權浮水印任務。 |
| SubmitTraceAbJob | 提交視訊溯源浮水印ab流作業 | 透過呼叫SubmitTraceAbJob介面提交視訊溯源浮水印ab流任務。 |
| SubmitTraceExtractJob | 提交溯源浮水印提取作業 | 呼叫此介面提交溯源浮水印提取作業。 |
| SubmitTraceM3u8Job | 提交視訊溯源浮水印m3u8作業 | 呼叫此介面提交視訊溯源浮水印m3u8任務。 |