調用本接口提交媒體轉碼作業,開始異步轉碼處理。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vod:SubmitTranscodeJobs | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoId | string | 是 | 視頻 ID。可通過以下方式獲取:
| 142710f878bd42508932f660d7b1**** |
TemplateGroupId | string | 是 | 視頻轉碼時使用的轉碼組 ID。使用指定的模板組進行轉碼,您可以登錄點播控制臺,選擇配置管理 >媒體處理配置 > 轉碼模板組查看模版組 ID。 | 0e408c803baf658ee637790c5d9f**** |
PipelineId | string | 否 | 管道 ID。 | d3e680e618708erf45fbf2cae7c**** |
EncryptConfig | string | 否 | 加密配置,為 JSON 字符串,只有使用 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 | 否 | 當前發起的轉碼作業在所有排隊作業中的優先級。
說明
Priority 參數只影響當前發起的轉碼作業在所有排隊狀態作業中的優先級,但不影響已經轉碼處理中的任務優先級。
| 6 |
UserData | string | 否 | 自定義設置。為 JSON 字符串,支持消息回調等設置。具體詳情,請參見 UserData 。 說明
此參數中消息回調的使用前提是需要在控制臺配置 HTTP 回調地址和勾選對應的回調事件類型才能使用,否則回調設置不生效。
| {"Extend":{"localId":"****","test":"***"}} |
SessionId | string | 否 | 自定義去重識別碼,如果 7 天內曾有過相同的識別碼的請求,則本次的請求會返回錯誤。 長度最長為 50 個字符,支持大小寫英文字母、數字、短劃線(-)和下劃線(_),不傳或者帶空字符串表示不去重。 | 5c62d40299034bbaa4c195da330**** |
返回參數
示例
正常返回示例
JSON
格式
{
"TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"TranscodeJobs": {
"TranscodeJob": [
{
"JobId": "d8921ce8505716cfe86fb112c4****"
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-28 | OpenAPI 入參發生變更 | 查看變更詳情 |