調用UploadMediaByURL基於源檔案URL,拉取音視頻媒體檔案進行上傳,支援批量上傳。本介面主要適用於檔案沒有儲存在本機伺服器或終端,需要通過公網訪問的URL地址上傳的情境。
介面說明
介面說明
如果配置了回調,則上傳完成後會收到 URL 上傳視頻完成的事件通知,可以通過擷取 URL 上傳資訊介面查詢上傳狀態。
上傳任務提交成功後,會在雲端產生非同步執行的任務,進行排隊執行;上傳完成後可根據事件通知(訊息回調)返回的 URL 和視頻 ID 等資訊進行關聯。
使用限制
-
本介面僅支援上傳至 VOD 點播儲存,不支援上傳至使用者自有 OSS 儲存。使用自有 OSS 儲存的使用者,可以先將檔案拉取到本地,通過OSS SDK上傳檔案至 OSS,然後再調用 RegisterMediaInfo 介面將 OSS 檔案註冊至媒資庫。
-
本介面目前僅支援華東 2(上海)、華北 2(北京)、華南 1(深圳)地區。
-
本介面僅支援上傳音視頻檔案。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:UploadMediaByURL |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| UploadURLs |
string |
否 |
媒體源檔案 URL。
|
https://diffurl.mp4 |
| AppId |
string |
否 |
應用 ID。 |
app-1000000 |
| UserData |
string |
否 |
自訂設定。為 JSON 字串,支援訊息回調等設定。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} |
| UploadTargetConfig |
string |
否 |
目標儲存地址。
|
{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"} |
| MediaMetaData |
string |
否 |
上傳媒體檔案的中繼資料資訊,為 JSON 字串。
|
[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}] |
| PostProcessConfig |
string |
否 |
Type = video || audio 有上傳後處理動作。 ProcessType 取值:Workflow。 |
{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"} |
| EntityId |
string |
否 |
實體 ID。可調用 CreateEntity 介面建立實體,自訂動態中繼資料結構。 |
d67281da3c8743b8823ad12976187*** |
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 編碼。 |
| WorkflowId | String | 否 | 工作流程 ID。 |
| FileExtension | String | 否 | 媒體檔案副檔名。 |
| DynamicMetaData | String | 否 | 動態中繼資料,例:"{"Uploader": "xxx"}"。 |
| EntityId | String | 否 | 實體 Id。 |
WorkflowId 參數任務為非同步任務,提交後任務尚未完成,任務將進入後台排隊非同步執行。
UploadMetadata 中的參數(如 Title、Description、Tags 等)不能包含Emoji。
如果配置了回調,視頻上傳完成後,除了上傳和轉碼通知,還有 URL 上傳視頻完成件通知。
批量提交時,每一個 SourceURL 有獨立的通知。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
****83B7-7F87-4792-BFE9-63CD2137**** |
| UploadJobs |
array<object> |
多個 Job 資訊。 |
|
|
object |
上傳任務詳情。 |
||
| JobId |
string |
上傳任務 ID。 |
20ce1e05dba64576b96e9683879f0*** |
| SourceURL |
string |
上傳任務對應的源檔案 URL。 |
http://example****.mp4 |
| MediaId |
string |
媒資 ID。 |
f476988629f54a7b8a4ba90d1a6c7*** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
"UploadJobs": [
{
"JobId": "20ce1e05dba64576b96e9683879f0***",
"SourceURL": "http://example****.mp4\n",
"MediaId": "f476988629f54a7b8a4ba90d1a6c7***"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。