SubmitTranscodeJobs - 提交媒體轉碼作業 -

調用本介面提交媒體轉碼作業，開始非同步轉碼處理。

介面說明

使用說明

請確保在使用該介面前，已充分瞭解ApsaraVideo for VOD產品的收費方式和價格。轉碼為付費功能，計費詳情，請參見媒資轉碼計費。
只有狀態為上傳完成、正常和審核中的視頻才能發起轉碼。
如需要擷取轉碼結果，可接收回調訊息：單個清晰度轉碼完成、全部轉碼完成。
該介面可支援 HLS 自適應碼流打包任務中對字幕地址進行動態替換，如打包任務無字幕打包處理，不建議採用該介面發起任務處理，而建議視頻上傳時設定對應的打包模板組 ID 即可自動發起打包流程。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:SubmitTranscodeJobs

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
VideoId	string	否	視頻 ID。可通過以下方式擷取：通過控制台上傳的視頻，可登入點播控制台，選擇媒資庫 > 音/視頻查看視頻 ID。通過 CreateUploadVideo 介面上傳視頻時，視頻 ID 為返回參數 VideoId 的值。視頻上傳後，可通過 SearchMedia 介面查詢視頻 ID，為請求後返回參數 VideoId 的值。	142710f878bd42508932f660d7b1****
TemplateGroupId	string	是	視頻轉碼時使用的轉碼組 ID。使用指定的模板組進行轉碼，您可以登入點播控制台，選擇組態管理 >ApsaraVideo for Media Processing配置 > 轉碼模板組查看模版組 ID。	0e408c803baf658ee637790c5d9f****
PipelineId	string	否	管道 ID。	d3e680e618708erf45fbf2cae7c****
EncryptConfig	string	否	加密配置，為 JSON 字串，只有使用 HLS 標準加密時才需要此參數。說明 EncryptConfig 結構體中 CipherText 參數必須為通過 GenerateKMSDataKey 產生的 AES_128 密文密鑰，否則標準加密轉碼失敗。標準加密接入流程，請參見 HLS 標準加密。無論標準加密、私人加密，TemplateGroupId 對應的模板資料，必須都勾選 HLS 加密選項，否則不加密。	{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**","KeyServiceType":"KMS"}
OverrideParams	string	否	覆蓋參數（JSON 字串），支援對轉碼模板關聯的指定圖片浮水印檔案、文字浮水印內容、字幕檔案地址以及字幕檔案編碼格式的覆蓋。參數結構詳情，請參見 OverrideParams 。	{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374**","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707**","Content":"watermark test"}]}
Priority	string	否	當前發起的轉碼作業在所有排隊作業中的優先順序。取值範圍：1~10。最高優先順序：10。預設值：6。說明 Priority 參數隻影響當前發起的轉碼作業在所有排隊狀態作業中的優先順序，但不影響已經轉碼處理中的任務優先順序。	6
UserData	string	否	自訂設定。為 JSON 字串，支援訊息回調等設定。具體詳情，請參見 UserData 。說明此參數中訊息回調的使用前提是需要在控制台配置 HTTP 回調地址和勾選對應的回調事件類型才能使用，否則回調設定不生效。	{"Extend":{"localId":"**","test":"*"}}
SessionId	string	否	自訂去重識別碼，如果 7 天內曾有過相同的識別碼的請求，則本次的請求會返回錯誤。長度最長為 50 個字元，支援大小寫英文字母、數字、短劃線（-）和底線（_），不傳或者帶Null 字元串表示不去重。	5c62d40299034bbaa4c195da330****
ReferenceId	string	否	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。	123-123

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
TranscodeTaskId	string	當前提交的轉碼任務 ID。	9f4a0df7da2c8a81c8c0408c84****
RequestId	string	請求 ID。	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
TranscodeJobs	object
TranscodeJob	array<object>	媒體作業資訊。說明 HLS 多碼率自適應打包任務不會返回該參數，需要非同步接收回調處理結果。
	object	媒體作業詳情。
JobId	string	作業 ID。說明 HLS 多碼率自適應打包任務不會返回該參數，需要非同步接收回調處理結果。	d8921ce8505716cfe86fb112c4****

樣本

正常返回樣本

JSON格式

{
  "TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "TranscodeJobs": {
    "TranscodeJob": [
      {
        "JobId": "d8921ce8505716cfe86fb112c4****"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。