上傳外部儲存的轉碼流檔案並掛載到對應的點播媒資下。
介面說明
請確保在使用該介面前,已充分瞭解ApsaraVideo for VOD產品的收費方式和價格。媒資檔案上傳到ApsaraVideo for VOD中會產生儲存費用,計費詳情,請參見媒資儲存計費。如果您已開通了儲存傳輸加速,則上傳媒資檔案到ApsaraVideo for VOD時還將涉及上傳加速費用,計費詳情請參見儲存傳輸加速計費。
該介面目前僅支援上海和新加坡地區使用。
調用本介面上傳外部儲存的轉碼流檔案並掛載到對應的點播媒資下。本介面支援的轉碼流 HDR 類型為 HDR、HDR10、HLG、DolbyVision、HDRVivid 和 SDR+類型。
您可以通過擷取 URL 上傳資訊介面來查詢上傳狀態,上傳完成後會收到 URL 上傳轉碼流完成的事件通知。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:UploadStreamByURL |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| StreamURL |
string |
是 |
轉碼流檔案 URL。 如果轉碼流的 URL 需要鑒權,需要在 StreamURL 中傳入鑒權參數,並確保該 URL 可以通過公網訪問。 說明
URL 可以通過控制台擷取音視頻的地址;也可以通過 getplayinfo 介面調用來擷取音視頻地址。 |
https://example.com/lesson-01.mp4 |
| MediaId |
string |
是 |
轉碼流對應的點播媒資 ID。 |
ca3a8f6e49*****57b65806709586 |
| Definition |
string |
是 |
視頻流清晰度。 取值,詳情請參考: 媒資參數說明-清晰度。 |
HD |
| FileExtension |
string |
否 |
轉碼流副檔名。 副檔名請參見概述中的音頻和視頻的支援檔案格式。 當該參數不為空白時,會覆蓋 StreamURL 地址中的副檔名。 重要 若 StreamURL 地址中不含副檔名,該參數必填。 |
mp4 |
| HDRType |
string |
否 |
轉碼流 HDR 類型。取值:
說明
|
HDR10 |
| UserData |
string |
否 |
使用者自訂參數。詳情參見 UserData 。 說明
此參數中訊息回調的使用前提是需要在控制台配置 HTTP 回調地址和勾選對應的回調事件類型才能使用,否則回調設定不生效。控制台配置 HTTP 回調的操作,請參考回調設定。 |
{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
| UploadMetadata |
string |
否 |
上傳媒體檔案的中繼資料資訊,為 JSON 字串。
|
{"AddressMapping":"1","CustomPath":"test/xxx","CustomFileName":"xxx.mp4","isOverwritePath":"0"} |
UploadMetadata
| 名稱 | 類型 | 是否必需 | 描述 |
| AddressMapping | String | 否 | 地址映射規則。取值:1 代表映射轉碼流的 URL,2 代表自訂路徑 |
| CustomPath | String | 否 | 自訂檔案路徑。長度不超過 1000 個位元組。UTF-8 編碼。 |
| CustomFileName | String | 否 | 自訂檔案名稱。長度不超過 1000 個位元組。UTF-8 編碼。 |
| IsOverwritePath | String | 否 | 自訂檔案路徑存在時是否覆蓋。取值:0 代表不覆蓋,1 代表覆蓋 |
當 AddressMapping 取值為 2 時,CustomPath 和 CustomFileName 均不可為空
當 IsOverwritePath 取值為 0 時,如果自訂的檔案路徑已經存在,介面會返回失敗
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
基本資料。 |
||
| RequestId |
string |
請求 ID。 |
7AE96389-DF1E-598D-816B-7B40F13B4620 |
| StreamJobId |
string |
轉碼流 JobId。可以作為 GetURLUploadInfos 介面的請求參數。 點播使用 JobId 唯一標識一個轉碼流檔案。詳情請參考:基本資料-PlayInfo 視頻播放資訊。 |
e304b34fb3d959f92baef97b6496**** |
| FileURL |
string |
轉碼流 OSS 檔案地址。 |
http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4 |
| SourceURL |
string |
轉碼流輸入 URL 地址。可以作為 GetURLUploadInfos 介面的請求參數。 |
https://example.com/lesson-01.mp4 |
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。