進行媒資注冊,接入點播服務的OSS自有Bucket上的存量媒資文件,需要進行媒資注冊生成點播需要的關聯數據后,才能正常使用點播提供的轉碼、截圖等功能。
接口說明
- 針對已接入點播服務的 OSS bucket,已存儲在 OSS bucket 上的音視頻媒體文件,需要通過注冊媒資接口生成點播需要的關聯數據后,才能在點播服務中對這些媒體文件通過媒體 ID 發起轉碼、截圖和 AI 處理等。
- 一次最多可注冊 10 個 OSS 媒體文件,且一次提交的媒體文件對應的存儲地址需要一致。
- 在點播中上傳的媒體文件,如未指定轉碼模板組 ID,則會按照默認模板組進行轉碼處理;與之不同的是,注冊媒資后,如未指定轉碼模板組 ID,則不會自動觸發轉碼;如指定了轉碼模板組 ID,則會按照指定的模板組進行轉碼處理。
- 重復注冊的媒體文件,只返回與其關聯的唯一媒體 ID,不做其他處理。
- 請確保您要注冊的媒資文件含有合法的后綴,否則會注冊失敗。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vod:RegisterMedia | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegisterMetadatas | string | 是 | 注冊媒資元數據。為 JSON 字符串,一次最多支持設置 10 個媒資元數據。參數結構的更多信息,請參見下表 RegisterMetadata。 | [{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}] |
TemplateGroupId | string | 否 | 轉碼模板組 ID。可通過以下方式獲取:
說明
| ca3a8f6e49c87b65806709586**** |
UserData | string | 否 | 自定義設置。為 JSON 字符串,支持消息回調等設置。參數詳情,請參見 UserData 。 說明
本接口不支持回調,即便此參數中設置了消息回調,在媒資注冊完成后也不會產生回調消息。當后續對注冊完成的媒資發起轉碼、截圖等媒體處理時,若在發起轉碼、截圖時單獨設置了 UserData 中的消息回調,則優先使用那個回調地址;未設置,則使用此處注冊媒資時 UserData 中設置的回調地址。
| {"Extend":{"localId":"****","test":"www"}} |
WorkflowId | string | 否 | 637adc2b7ba51a83d841606f8**** |
RegisterMetadata
指定要注冊的媒資元數據。
名稱 | 類型 | 是否必選 | 描述 |
---|---|---|---|
FileURL | String | 是 | 源文件地址。可通過獲取源文件信息接口獲取。 長度不超過 1024 個字節,文件名需要保證全局唯一。添加相同文件名稱時,則關聯唯一媒體 ID。 |
Title | String | 是 | 標題。長度不超過 128 個字節。UTF8 編碼。 |
Description | String | 否 | 描述。長度不超過 1024 個字節。UTF8 編碼。 |
Tags | String | 否 | 標簽。單個標簽不超過 32 個字節,最多不超過 16 個標簽,多個標簽之間用半角逗號(,)分隔。UTF8 編碼。 |
CoverURL | String | 否 | 封面 URL。長度不超過 1024 個字節。 |
CateId | Long | 否 | 分類 ID。可通過以下方式獲取: 登錄點播控制臺,選擇配置管理 > 媒資管理配置 > 分類管理查看分類 ID。 通過創建分類接口創建分類時,分類 ID 為返回參數 CateId 的值。 通過獲取分類及子分類接口查詢分類時,為請求后返回參數 CateId 的值。 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "14F43C5C-8033-448B-AD04F64E5098****",
"FailedFileURLs": [
"[\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\"]"
],
"RegisteredMediaList": [
{
"NewRegister": false,
"FileURL": "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
"MediaId": "d97af32828084d1896683b1aa38****"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史