基於來源檔案 URL,拉取影音媒體檔案進行上傳,支援批次上傳。
介面說明
請確保在使用該介面前,已充分了解影片點播產品的收費方式和價格。媒資檔案上傳到影片點播中會產生儲存費用,計費詳情,請參見媒資儲存計費。如果您已啟用了儲存傳輸加速,則上傳媒資檔案到影片點播時還將涉及上傳加速費用,計費詳情請參見儲存傳輸加速計費。
本介面支援上傳的媒體檔案格式,請參見媒體格式。
本介面主要適用於檔案沒有儲存在本機伺服器或終端,需要透過公網存取的 URL 位址上傳的情境。
本介面為非同步上傳介面,非即時,不保證時效性,一般提交後會在數小時、甚至數天內完成遷移上傳。如果對時效性要求較高,建議使用上傳 SDK 上傳。
如果設定了回呼,則上傳完成後會收到URL 上傳影片完成的事件通知,可以透過獲取 URL 上傳資訊介面查詢上傳狀態。
上傳任務提交成功後,會在雲端產生非同步執行的任務,相應服務地域下所有使用者提交的 URL 上傳任務進行排隊執行,完成時間受已有任務數量影響;上傳完成後可根據事件通知(訊息回呼)返回的 URL 和影片 ID 等資訊進行關聯。
本介面目前僅支援華東 2(上海)、華北 2(北京)、華南 1(深圳)、新加坡、美國(矽谷)地域。
同一個媒體檔案 URL,每次提交上傳任務都會在點播中產生一個新的媒體資源(即產生新的媒體 ID)。
單一檔案超過 20GB 時,將導致上傳失敗。如您有單一檔案超過 20GB 的上傳需求,請使用上傳 SDK 進行上傳。詳細資訊請參見上傳 SDK 概述。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:UploadMediaByURL |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| UploadURLs |
string |
是 |
媒體來源檔案 URL。
說明
|
https://****.mp4 |
| TemplateGroupId |
string |
否 |
轉碼範本群組 ID。可透過以下方式獲取:
說明
|
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 |
否 |
自訂設定。為 JSON 字串,支援訊息回呼、上傳加速等設定。更多資訊,請參見 UserData 。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} |
| AppId |
string |
否 |
應用程式 ID。預設取值:app-1000000。更多資訊,請參見多應用。 |
app-**** |
| WorkflowId |
string |
否 |
工作流程 ID。可登入點播主控台,選擇配置管理 > 媒體處理配置 > 工作流程管理檢視工作流程 ID。 說明
如果同時傳遞了 WorkflowId 和 TemplateGroupId,以 WorkflowId 為準。使用說明,請參見工作流程。 |
e1e243b42548248197d6f74f9**** |
| SessionId |
string |
否 |
自訂去重識別碼,如果傳遞了該參數請求,當偵測到在過去 10 分鐘內曾有過相同識別碼的請求,則會在本次請求時返回錯誤。 說明
|
5c62d40299034bbaa4c195da330**** |
| EnableFirstFrameCover |
boolean |
否 |
||
| GenerateThumbnail |
boolean |
否 |
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 | 否 | 媒體檔案副檔名,支援的副檔名,請參見上傳概述。 |
| ReferenceId | String | 否 | 自訂 ID,僅支援小寫字母、大寫字母、數字、橫線、底線,長度 6-64 位元。使用者維度唯一。 |
UploadMetadata 中的參數(如 Title、Description、Tags 等)不能包含表情符號。
為確保正常播放,當 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****"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。