使用RegisterMediaInfo註冊媒資-智能媒體服務-阿里雲

發起一個註冊媒資的任務，賦予新媒資一個IMS的mediaId。介面根據InputURL，非同步呼叫其他媒資資訊服務，擷取媒資的檔案資訊。同時使用者可以設定一些基本資料的值，如標題、標籤、描述等。介面同步返回mediaId，使用者可以調用擷取媒資內容資訊GetMediaInfo的介面，擷取具體的媒資資訊。當前僅支援InputURL為OSS檔案或VOD媒資。

介面說明

註冊媒資是一個非同步任務，一般需要 2-3s 完成。當註冊介面返回 mediaId 時，可能媒資還沒有註冊完成，此時調用 GetMediaInfo 無法擷取到媒資的檔案資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:RegisterMediaInfo

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InputURL	string	是	待註冊的媒資在相應系統中的地址，一經註冊不可更改，並與 IMS 的 mediaId 綁定。 OSS 地址，支援兩種格式。 http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 oss://example-bucket/example.mp4 （此格式預設 oss region 與服務接入地區一致） VOD 媒資 vod://*20b48fb04483915d4f2cd8ac**	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://**20b48fb04483915d4f2cd8ac**
MediaType	string	否	媒資媒體類型。取值範圍： "image" 圖片 "video" 視頻 "audio" 音頻 "text" 文字當取值為"text"時，businessType 需對應"subtitles"或"font"。此欄位建議使用者按需填寫。當 InputURL 欄位是 OSS URL 時，也支援按照檔案尾碼自動判斷媒資類型（僅限圖片、視頻、音頻檔案尾碼），對應關係見檔案格式。	video
BusinessType	string	否	媒資業務類型。取值範圍： "subtitles" 字幕 "font" 字型 "watermark" 浮水印 "opening" 標題/開場 "ending" 片尾 "general" 通用	opening
Title	string	否	標題，若不提供，根據日期自動產生預設 title。長度不超過 128 位元組。 UTF8 編碼。	defaultTitle
Description	string	否	內容描述。長度不超過 1024 位元組 UTF8 編碼。	defaultDescription
MediaTags	string	否	標籤。最多不超過 16 個標籤。多個用逗號分隔。單個標籤不超過 32 位元組。 UTF8 編碼。	tag1,tag2
CoverURL	string	否	封面地址。長度不超過 128 位元組。 UTF8 編碼。	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png
UserData	string	否	使用者資料。支援自訂回調地址配置，配置說明可參考配置剪輯完成時的回調長度不超過 1024 位元組。 UTF8 編碼。 Json 格式	{"NotifyAddress":"http://xx.xx.xxx"} 或{"NotifyAddress":"https://xx.xx.xxx"} 或{"NotifyAddress":"ice-callback-demo"}
Overwrite	boolean	否	是否覆蓋登入媒資，預設 false。 -true，如果 inputUrl 登入，刪除原有媒資並註冊新媒資； -false, 如果 inputUrl 登入則不予註冊新媒資，暫不支援重複的 inputUrl。	true
ClientToken	string	否	用戶端 token，32 位 UUID，保證請求等冪性。	**0311a423d11a5f7dee713535**
RegisterConfig	string	否	註冊配置。預設為媒資產生雪碧圖，如不需要可以手動設定 NeedSprite 欄位為 false。預設產生截圖，如不需要可以手動設定 NeedSnapshot 欄位為 false。如需指定封面圖時間，需配置 CoverConfig，包含欄位： StartTime: 封面圖位於素材的第幾秒，支援四位小數。媒資註冊後，如需匯入自訂搜尋庫，需配置 SearchLibName。如何建立並使用自訂搜尋庫，詳見自建搜尋庫的使用流程。	{ "NeedSprite": "false", "CoverConfig": { "StartTime": 1.0 }, "SearchLibName": "test" }
CateId	integer	否	分類別識別碼。	3048
WorkflowId	string	否	工作流程 ID	****b4fb044839815d4f2cd8****
ReferenceId	string	否	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。需保證使用者維度唯一。	123-123
SmartTagTemplateId	string	否	智能標籤模板。取值： S00000101-300080：包含 NLP 內容理解功能的系統模板 S00000103-000001：包含 NLP 內容理解功能和所有標籤能力 S00000103-000002：包含所有標籤能力，不包含 NLP 內容理解功能標籤能力詳見：配置該欄位後，媒資註冊完成會自動發起智能標籤分析任務，相關計費項目請參考智能標籤標準版計費。	S00000101-300080

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	****5A-CAAC-4850-A3AF-B74606****
MediaId	string	IMS 媒資 ID。	****b48fb04483915d4f2cd8****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "******5A-CAAC-4850-A3AF-B74606******",
  "MediaId": "******b48fb04483915d4f2cd8******"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden	User not authorized to operate on the specified resource.

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

變更歷史

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