基于源文件URL,拉取音視頻媒體文件進行上傳,支持批量上傳。
接口說明
- 請確保在使用該接口前,已充分了解視頻點播產品的收費方式和價格。媒資文件上傳到視頻點播中會產生存儲費用,計費詳情,請參見媒資存儲計費。如果您已開通了存儲傳輸加速,則上傳媒資文件到視頻點播時還將涉及上傳加速費用,計費詳情請參見存儲傳輸加速計費。
- 本接口支持上傳的媒體文件格式,請參見媒體格式。
- 本接口主要適用于文件沒有存儲在本地服務器或終端,需要通過公網訪問的 URL 地址上傳的場景。
- 本接口為異步上傳接口,非實時,不保證時效性,一般提交后會在數小時、甚至數天內完成遷移上傳。如果對時效性要求較高,建議使用上傳 SDK 上傳。
- 如果配置了回調,則上傳完成后會收到 URL 上傳視頻完成的事件通知,可以通過獲取 URL 上傳信息接口查詢上傳狀態。
- 上傳任務提交成功后,會在云端生成異步執行的任務,相應服務地域下所有用戶提交的 URL 上傳任務進行排隊執行,完成時間受已有任務數量影響;上傳完成后可根據事件通知(消息回調)返回的 URL 和視頻 ID 等信息進行關聯。
- 本接口目前僅支持華東 2(上海)和新加坡地域。
- 同一個媒體文件 URL,每次提交上傳任務都會在點播中產生一個新的媒體資源(即產生新的媒體 ID)。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vod:UploadMediaByURL | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
UploadURLs | string | 是 | 媒體源文件 URL。
說明
| https://****.mp4 |
TemplateGroupId | string | 否 | 轉碼模板組 ID。可通過以下方式獲取:
說明
UploadMetadatas 中進行設置,如果在 UploadMetadatas 中設置了 TemplateGroupId,此處也設置了 TemplateGroupId,則以 UploadMetadatas 中設置的 TemplateGroupId 為準。 | ca3a8f6e4957b65806709586**** |
StorageLocation | string | 否 | 媒體文件存儲地址。 登錄點播控制臺,選擇配置管理 > 媒資管理配置 > 存儲管理查看存儲地址。不指定時會使用默認存儲地址。 | outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com |
UploadMetadatas | string | 否 | 上傳媒體文件的元數據信息,為 JSON 字符串。
| [{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}] |
UserData | string | 否 | {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} | |
AppId | string | 否 | 應用 ID。默認取值:app-1000000。 更多信息,請參見多應用。 | app-**** |
WorkflowId | string | 否 | e1e243b42548248197d6f74f9**** | |
SessionId | string | 否 | 自定義去重識別碼,如果傳遞了該參數請求,當檢測到在過去 10 分鐘內曾有過相同識別碼的請求,則會在本次請求時返回錯誤。 說明
| 5c62d40299034bbaa4c195da330**** |
UploadMetadata
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
SourceURL | String | 是 | 需要上傳的媒體源文件 URL。 |
Title | String | 否 | 媒體標題。長度不超過 128 個字節。UTF-8 編碼。 |
FileSize | String | 否 | 文件大小。 |
Description | String | 否 | 描述。長度不超過 1024 個字節。UTF-8 編碼。 |
CoverURL | String | 否 | 自定義視頻封面 URL 地址。 |
CateId | String | 否 | 分類 ID。可通過登錄點播控制臺,選擇配置管理 > 媒資管理配置 > 分類管理查看分類 ID。 |
Tags | String | 否 | 標簽。單個標簽不超過 32 字節,最多不超過 16 個標簽。多個標簽,請使用半角逗號(,)分隔。UTF8 編碼。 |
TemplateGroupId | String | 否 | 轉碼模板組 ID。會覆蓋外層傳入的 TemplateGroupId。 |
WorkflowId | String | 否 | 工作流 ID。如果同時傳入了 WorkflowId 和 TemplateGroupId,以 WorkflowId 為準。更多信息,請參見工作流。 |
FileExtension | String | 否 | 媒體文件擴展名,支持的擴展名,請參見上傳概述。 |
說明
UploadMetadata 中的參數(如 Title、Description、Tags 等)不能包含表情符。
為確保正常播放,當 TemplateGroupId 設置為“VOD_NO_TRANSCODE”不轉碼的方式上傳視頻文件后,目前僅以下格式的文件支持不轉碼直接播放:MP4、FLV、MP3、M3U8、WEBM,其他格式僅支持存儲(關注 FileName 的擴展名)。若使用阿里云播放器,版本須為 3.1.0 或以上。
指定不轉碼的模板組(TemplateGroupId 設置為“VOD_NO_TRANSCODE”),視頻上傳后僅有視頻上傳完成的事件通知,沒有單個清晰度轉碼完成的事件通知。
如果配置了回調,視頻上傳完成后,除了上傳和轉碼通知,還有 URL 上傳視頻完成事件通知。
批量提交時,每一個 SourceURL 有獨立的通知。
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"UploadJobs": [
{
"SourceURL": "http://example****.mp4",
"JobId": "ad90a501b1b94fb72374ad005046****"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-05-16 | OpenAPI 入參發生變更 | 查看變更詳情 |