UploadMediaByURL - URL批量拉取上傳 -

介面說明

請確保在使用該介面前，已充分瞭解ApsaraVideo for VOD產品的收費方式和價格。媒資檔案上傳到ApsaraVideo for VOD中會產生儲存費用，計費詳情，請參見媒資儲存計費。如果您已開通了儲存傳輸加速，則上傳媒資檔案到ApsaraVideo for VOD時還將涉及上傳加速費用，計費詳情請參見儲存傳輸加速計費。
本介面支援上傳的媒體檔案格式，請參見媒體格式。
本介面主要適用於檔案沒有儲存在本機伺服器或終端，需要通過公網訪問的 URL 地址上傳的情境。
本介面為非同步上傳介面，非即時，不保證時效性，一般提交後會在數小時、甚至數天內完成遷移上傳。如果對時效性要求較高，建議使用上傳 SDK 上傳。
如果配置了回調，則上傳完成後會收到 URL 上傳視頻完成的事件通知，可以通過擷取 URL 上傳資訊介面查詢上傳狀態。
上傳任務提交成功後，會在雲端產生非同步執行的任務，相應服務地區下所有使用者提交的 URL 上傳任務進行排隊執行，完成時間受已有任務數量影響；上傳完成後可根據事件通知（訊息回調）返回的 URL 和視頻 ID 等資訊進行關聯。
本介面目前僅支援華東 2（上海）、華北 2（北京）、華南 1（深圳）、新加坡、美國（矽谷）地區。
同一個媒體檔案 URL，每次提交上傳任務都會在點播中產生一個新的媒體資源（即產生新的媒體 ID）。
單個檔案超過 20GB 時，將導致上傳失敗。如您有單個檔案超過 20GB 的上傳需求，請使用上傳 SDK 進行上傳。詳細資料請參見上傳 SDK 概述。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:UploadMediaByURL

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
UploadURLs	string	是	媒體源檔案 URL。 URL 中需要包括副檔名, 比如`https://**.mp4`中 mp4 為副檔名。如果 URL 中不包含副檔名，可以在`UploadMetadatas`中傳入`FileExtension`來指定。如果 URL 中有副檔名且同時傳入`FileExtension`，以傳入的`FileExtension`為準。指定支援的副檔名，請參見上傳概述。說明 URL 編碼，多個地址之間以半形逗號（,）分隔，最多支援 20 個，避免存在特殊字元導致無法上傳視頻，需要 URL 編碼後**再做逗號拼接。	https://****.mp4
TemplateGroupId	string	否	轉碼模板組 ID。可通過以下方式擷取：登入點播控制台，選擇組態管理 > ApsaraVideo for Media Processing配置 > 轉碼模板組查看轉碼模版組 ID。通過建立轉碼模板組介面建立轉碼模板組時，轉碼模板組 ID 為返回參數 TranscodeTemplateGroupId 的值。通過查詢轉碼配置列表介面查詢轉碼模板組時，為請求後返回參數 TranscodeTemplateGroupId 的值。說明不設定轉碼模板組 ID，則按預設的轉碼模板組進行轉碼；設定了轉碼模板組 ID 時，會使用該指定的模板組進行轉碼。可以在`UploadMetadatas`中進行設定，如果在 UploadMetadatas 中設定了 TemplateGroupId，此處也設定了 TemplateGroupId，則以 UploadMetadatas 中設定的 TemplateGroupId 為準。	ca3a8f6e4957b65806709586****
StorageLocation	string	否	媒體檔案儲存地址。登入點播控制台，選擇組態管理 > 媒資管理配置 > 儲存管理查看儲存地址。不指定時會使用預設儲存地址。	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
UploadMetadatas	string	否	上傳媒體檔案的中繼資料資訊，為 JSON 字串。與 UploadURLs 裡的 URL 匹配才會生效。 JSON 格式：`[UploadMetadata, UploadMetadata,…]`，需轉為 JSON 字串。更多資訊，請參見下表 UploadMetadata。	[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]
UserData	string	否	自訂設定。為 JSON 字串，支援訊息回調、上傳加速等設定。更多資訊，請參見 UserData 。說明此參數中訊息回調的使用前提是需要在控制台配置 HTTP 回調地址和勾選對應的回調事件類型才能使用，否則回調設定不生效。控制台配置 HTTP 回調的操作，請參考回調設定。如需使用上傳加速功能，您需要提交工單申請開通，更多資訊，請參見上傳相關說明。關於如何提交工單，請參見聯絡我們。	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
AppId	string	否	應用 ID。預設取值：app-1000000。更多資訊，請參見多應用。	app-****
WorkflowId	string	否	工作流程 ID。可登入點播控制台，選擇組態管理 > ApsaraVideo for Media Processing配置 > 工作流程管理查看工作流程 ID。說明如果同時傳遞了 WorkflowId 和 TemplateGroupId，以 WorkflowId 為準。使用說明，請參見工作流程。	e1e243b42548248197d6f74f9****
SessionId	string	否	自訂去重識別碼，如果傳遞了該參數請求，當檢測到在過去 10 分鐘內曾有過相同識別碼的請求，則會在本次請求時返回錯誤。說明該去重識別碼由您自訂設定，長度最長為 50 個字元，支援大小寫英文字母、數字、短劃線（-）和底線（_），不傳或者帶Null 字元串表示不去重。	5c62d40299034bbaa4c195da330****

UploadMetadata

名稱	類型	是否必需	描述
SourceURL	String	是	需要上傳的媒體源檔案 URL。
Title	String	否	媒體標題。長度不超過 128 個位元組。UTF-8 編碼。
FileSize	String	否	檔案大小。
Description	String	否	描述。長度不超過 1024 個位元組。UTF-8 編碼。
CoverURL	String	否	自訂視頻封面 URL 地址。
CateId	String	否	分類別識別碼。可通過登入點播控制台，選擇組態管理 > 媒資管理配置 > 分類管理查看分類別識別碼。
Tags	String	否	標籤。單個標籤不超過 32 位元組，最多不超過 16 個標籤。多個標籤，請使用半形逗號（,）分隔。UTF8 編碼。
TemplateGroupId	String	否	轉碼模板組 ID。會覆蓋外層傳入的 TemplateGroupId。
WorkflowId	String	否	工作流程 ID。如果同時傳入了 WorkflowId 和 TemplateGroupId，以 WorkflowId 為準。更多資訊，請參見工作流程。
FileExtension	String	否	媒體檔案副檔名，支援的副檔名，請參見上傳概述。
ReferenceId	String	否	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。

說明

UploadMetadata 中的參數（如 Title、Description、Tags 等）不能包含Emoji。
為確保正常播放，當 TemplateGroupId 設定為“VOD_NO_TRANSCODE”不轉碼的方式上傳視頻檔案後，目前僅以下格式的檔案支援不轉碼直接播放：MP4、FLV、MP3、M3U8、WEBM，其他格式僅支援儲存（關注 FileName 的副檔名）。若使用阿里雲播放器，版本須為 3.1.0 或以上。
指定不轉碼的模板組（TemplateGroupId 設定為“VOD_NO_TRANSCODE”），視頻上傳後僅有視頻上傳完成的事件通知，沒有單個清晰度轉碼完成的事件通知。
如果配置了回調，視頻上傳完成後，除了上傳和轉碼通知，還有 URL 上傳視頻完成事件通知。
批量提交時，每一個 SourceURL 有獨立的通知。

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	25818875-5F78-4AF6-D7393642CA58****
UploadJobs	array<object>	上傳工作清單。
	object	上傳任務詳情。
SourceURL	string	上傳任務對應的源檔案 URL。	http://example****.mp4
JobId	string	上傳任務 ID。	ad90a501b1b94fb72374ad005046****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "UploadJobs": [
    {
      "SourceURL": "http://example****.mp4",
      "JobId": "ad90a501b1b94fb72374ad005046****"
    }
  ]
}

錯誤碼

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

變更歷史

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