全部產品
Search
文件中心

ApsaraVideo Media Processing:AddMedia

更新時間:Aug 28, 2026

提交新增媒體作業。

介面說明

  • 當在 OSS 上有存量影片時,可以透過此介面處理存量影片,從而避免重新上傳影片到 OSS。如果已經設定過工作流程,上傳媒體檔案到 OSS 後,OSS 會自動通知 MPS。根據設定的 OSS Bucket,Object 會自動匹配處於啟用狀態的工作流程並自動執行,因此通常情況下不需要手動呼叫 AddMedia 介面來處理檔案。

  • 只有指定啟用狀態的工作流程處理媒體檔案時,才會自動獲取媒體資訊;不指定工作流程或指定其他狀態的工作流程時,不會獲取媒體資訊。

QPS 限制

本介面的單一使用者 QPS 限制為 100 次/秒。超過限制時,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。更多資訊,請參見 QPS 限制

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mts:AddMedia

create

*全部資源。

*

請求參數

名稱

類型

必填

描述

樣本值

FileURL

string

輸入檔案的路徑,可以透過 MPS 或 OSS 主控台獲取。詳細觸發規則請參見下文中工作流程觸發匹配規則

  • 僅支援 OSS HTTP 位址,不支援 CDN 位址和 HTTPS 位址。

  • 不超過 3200 位元組。

  • URL 遵循 RFC 2396(UTF-8 編碼,並進行 URLEncode)。更多資訊,請參見 URLEncode 說明

http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4

Title

string

媒體標題。

  • 長度限制不超過 128 個位元組。

  • UTF-8 編碼。

mytest

Description

string

描述。

  • 長度限制不超過 1024 個位元組。

  • UTF-8 編碼。

A test video

CoverURL

string

封面 URL。即您需要設定的封面的儲存位址,可以透過 MPS 主控台 > 工作流程管理 > 媒體 BucketOSS 主控台 > 我的存取路徑獲取。

  • 不超過 3200 位元組。

  • URL 遵循 RFC 2396(UTF-8 編碼,並進行 URLEncode)。更多資訊,請參見 URLEncode 說明

http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png

Tags

string

標籤清單。

說明

媒體處理中,每個媒體的每個標籤都是獨立的,可以透過搜尋媒體庫來尋找所有設定了相同標籤的媒體。

  • 用半形逗號(,)分隔,不超過 16 個標籤。

  • 單個標籤不能超過 32 個位元組。

  • UTF-8 編碼。

tag1,tag2

MediaWorkflowId

string

媒體工作流程 ID。可透過 MPS 主控台或新增媒體工作流程介面獲取。

說明
  • 該參數任務為非同步任務,提交後任務尚未完成,任務將進入背景排隊非同步執行。

07da6c65da7f458997336e0de192****

MediaWorkflowUserData

string

媒體工作流程使用者自訂資料。

  • 不超過 1024 位元組。

  • UTF-8 編碼。

test

InputUnbind

boolean

是否檢查指定的工作流程支援輸入路徑。此處建議您選擇檢查(true),避免因路徑出錯而導致的錯誤。取值:

  • true:檢查

  • false:不檢查

false

CateId

integer

媒體所屬類目 ID。不允許為負數。

123

OverrideParams

string

覆蓋參數。

  • 範例 1:HLS 打包字幕覆蓋 {“WebVTTSubtitleOverrides”,[{“RefActivityName”:”subtitleNode”,”WebVTTSubtitleURL”:”http://test.oss-cn-hangzhou.aliyuncs.com/example1.vtt"}]}

  • 範例 2:DASH 打包字幕覆蓋 {“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://subtitleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}

{“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://exampleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}

工作流程觸發匹配規則

規則匹配執行策略如下:以新增檔案的路徑為基礎,檢查工作流程綁定的位置,如果新增檔案的路徑中包含規則綁定的字串則匹配,不包含則不匹配。例如:http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv 規則:

1、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/          匹配
2、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/            匹配
3、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/              匹配
4、http://bucket.oss-cn-hangzhou.aliyuncs.com/                匹配
5、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv  匹配
6、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/         不匹配
7、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/           不匹配
8、http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/         不匹配
說明

在新增媒體工作流程時,請您不要設定一個工作流程的輸入路徑為另一個工作流程的輸入路徑的前綴,否則會導致一個增量檔案觸發兩次工作流程執行個體。例如:兩個工作流程的輸入路徑分別設定為 test 和 test1,則當輸入檔案上傳到 test1 資料夾下同樣滿足 test 前綴,因此會觸發兩次工作流程執行個體。

匹配檔案副檔名

觸發要求必須是多媒體檔案,媒體庫服務是透過檔案副檔名來判斷的。檔案或者沒有副檔名(檔案名稱中不包含副檔名分隔符號「.」),或者副檔名符合下面的規則:

說明

對於 swf,截圖及轉碼服務品質不保障。

類型副檔名
影片3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm
音訊aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff

媒體工作流程訊息

媒體工作流程採用阿里雲輕量訊息佇列(原 MNS)發送訊息給影片雲端服務接入方,媒體工作流程會在(Start/Report)活動節點完成時發送訊息,若需要接收訊息,需要在 Start 活動上設定佇列/通知名稱,媒體工作流程產生的訊息儲存在佇列/通知中,可以使用 輕量訊息佇列(原 MNS)SDK 獲取訊息,訊息規格如下:

名稱類型描述
RunIdString工作流程執行 ID。
NameString活動名稱。
TypeString活動類型。範圍:Report、Start
StateString活動狀態。範圍:Fail、Success
CodeString錯誤碼。如果活動狀態是 Fail 時,會給出具體的錯誤碼。
MessageString錯誤訊息。如果活動狀態是 Fail 時,會給出詳細的錯誤描述資訊。
MediaWorkflowExecutionMediaWorkflowExecution媒體工作流程執行資訊。

返回參數

名稱

類型

描述

樣本值

object

返回參數。

RequestId

string

請求 ID。

05F8B913-E9F3-4A6F-9922-48CADA0FFAAD

Media

object

媒體資訊。

CreationTime

string

建立時間。

2016-09-20T03:02:40Z

CateId

integer

類目 ID。

1

Height

string

媒體檔案高度。

1280

CensorState

string

影片審核狀態。取值:

  • Initiated:初始(上傳成功審核未完成)。

  • Pass:通過(上傳成功審核已通過)。

Initiated

Tags

object

Tag

array

標籤。

string

標籤清單。

tag,tag2

Bitrate

string

位元率。

1148.77

MediaId

string

媒體 ID。

3e6149d5a8c944c09b1a8d2dc3e4****

File

object

原始檔案。

State

string

檔案狀態。此處預設為 Normal(正常)。

Normal

URL

string

檔案 URL。

http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4

PublishState

string

媒體發佈狀態,表示是否對外發佈媒體。取值:

  • Initiated:初始。

  • UnPublish:未發佈,OSS 播放檔案權限為 Private。

  • Published:已發佈,OSS 播放檔案權限為 Default。

Published

Description

string

描述。長度不超過 1024 個位元組。

A test video

Width

string

媒體檔案寬度。

1280

Size

string

媒體檔案大小。

379860

CoverURL

string

封面 URL。

http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png

RunIdList

object

RunId

array

媒體工作流程執行個體 ID 清單。

string

已執行的媒體工作流程執行個體 ID 清單,以半形逗號(,)分隔。

{"RunId":["cbad98d35629470fa05ff393d347****"]}

Duration

string

媒體檔案時長。

2.645333

Fps

string

媒體檔案幀率。

25.0

Title

string

媒體標題。長度不超過 128 個位元組。

mytest.mp4

Format

string

格式。支援 mov、mp4、m4a、3gp、3g2、mj2。

mp4

樣本

正常返回樣本

JSON格式

{
  "RequestId": "05F8B913-E9F3-4A6F-9922-48CADA0FFAAD",
  "Media": {
    "CreationTime": "2016-09-20T03:02:40Z",
    "CateId": 1,
    "Height": "1280",
    "CensorState": "Initiated",
    "Tags": {
      "Tag": [
        "tag,tag2"
      ]
    },
    "Bitrate": "1148.77",
    "MediaId": "3e6149d5a8c944c09b1a8d2dc3e4****",
    "File": {
      "State": "Normal",
      "URL": "http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4"
    },
    "PublishState": "Published",
    "Description": "A test video",
    "Width": "1280",
    "Size": "379860",
    "CoverURL": "http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png",
    "RunIdList": {
      "RunId": [
        "{\"RunId\":[\"cbad98d35629470fa05ff393d347****\"]}"
      ]
    },
    "Duration": "2.645333",
    "Fps": "25.0",
    "Title": "mytest.mp4",
    "Format": "mp4"
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情