メディアファイルの追加 - MPS - Alibaba Cloud - ApsaraVideo Media Processing

新しいメディアジョブを作成します。

操作説明

この API は、Object Storage Service (OSS) に存在するメディアファイルを処理するため、ファイルを再アップロードする必要はありません。ワークフローを設定している場合、メディアファイルが OSS にアップロードされると、OSS は自動的に ApsaraVideo Media Processing (MPS) に通知します。その後、MPS は指定された OSS バケットとオブジェクトに基づいて、一致するアクティブなワークフローを自動的に実行します。したがって、通常、ファイル処理のために AddMedia API を手動で呼び出す必要はありません。
アクティブなワークフローは、メディアファイルの処理時にメディア情報を自動的に取得します。非アクティブなワークフローを指定した場合、またはワークフローを指定しなかった場合、メディア情報は取得されません。

QPS 制限

この API の QPS 制限は、単一ユーザーあたり毎秒 100 リクエストです。この制限を超えると、システムは API 呼び出しをスロットリングします。これはビジネスに影響を与える可能性があるため、呼び出しを適切に計画してください。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mts:AddMedia

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileURL	string	必須	入力ファイルの OSS URL。この URL は、MPS コンソールまたは OSS コンソールから取得できます。トリガールールの詳細については、「ワークフローのトリガーマッチングルール」をご参照ください。 OSS の HTTP URL のみがサポートされています。CDN および HTTPS の URL はサポートされていません。 URL の長さは最大 3,200 バイトです。 URL は、UTF-8 で URL エンコードされ、RFC 2396 に準拠している必要があります。詳細については、「URL エンコーディング」をご参照ください。	http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4
Title	string	任意	メディアファイルのタイトル。最大長：128 バイト。 UTF-8 エンコード。	mytest
Description	string	任意	メディアファイルの説明。最大長：1,024 バイト。 UTF-8 エンコード。	A test video
CoverURL	string	任意	メディアカバーの URL。この URL は、MPS コンソール ([ワークフロー管理] > [メディアバケット]) または OSS コンソール ([マイアクセスパス]) で取得できます。 URL の長さは最大 3,200 バイトです。 URL は、UTF-8 で URL エンコードされ、RFC 2396 に準拠している必要があります。詳細については、「URL エンコーディング」をご参照ください。	http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png
Tags	string	任意	タグのリスト。説明 ApsaraVideo Media Processing では、メディアファイルの各タグは独立しています。メディアライブラリを検索して、同じタグを持つすべてのメディアファイルを見つけることができます。複数のタグはコンマ (,) で区切ります。最大 16 個のタグを追加できます。各タグの長さは最大 32 バイトです。 UTF-8 エンコード。	tag1,tag2
MediaWorkflowId	string	任意	メディアワークフローの ID。この ID は MPS コンソールで確認するか、AddMediaWorkflow 操作を呼び出して取得できます。説明このパラメーターは、非同期タスクをキューに入れ、バックグラウンドで実行します。	07da6c65da7f458997336e0de192****
MediaWorkflowUserData	string	任意	メディアワークフローのユーザー定義データ。最大長：1,024 バイト。 UTF-8 エンコード。	test
InputUnbind	boolean	任意	指定されたワークフローが入力パスをサポートしているかどうかを確認するかどうかを指定します。無効なパスによるエラーを防ぐには、このパラメーターを `true` に設定します。有効な値： true：ワークフローが入力パスをサポートしているか確認します。 false：ワークフローが入力パスをサポートしているか確認しません。	false
CateId	integer	任意	メディアファイルのカテゴリ ID。この値は負数にできません。	123
OverrideParams	string	任意	オーバーライドパラメーター。JSON 文字列として指定します。例 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 の 2 つのワークフローを設定した場合、test1 ディレクトリにアップロードされたファイルは test プレフィックスにも一致し、両方のワークフローがトリガーされます。

ファイル拡張子のマッチング

ApsaraVideo Media Processing は、マルチメディアファイルのワークフローのみをトリガーします。ファイルの種類はファイル拡張子によって識別されます。ファイルの拡張子がサポートされているリストにある場合、または拡張子がない場合 (ファイル名にピリオドが含まれていない場合)、ファイルはワークフローをトリガーします。

説明

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

メディアワークフローメッセージ

メディアワークフローは、Message Service (MNS) を使用して、ビデオクラウドサービスアプリケーションに通知を送信します。Start または Report アクティビティノードが完了すると、システムはメッセージを送信します。これらのメッセージを受信するには、Start アクティビティノードでキューまたはトピック名を指定する必要があります。これらのメッセージは指定されたキューまたはトピックに保存され、MNS SDK を使用して取得できます。メッセージのフォーマットは次のとおりです：

パラメーター	タイプ	説明
RunId	String	ワークフロー実行の ID。
Name	String	アクティビティノードの名前。
Type	String	アクティビティノードのタイプ。有効な値：`Start` および `Report`。
State	String	アクティビティノードの状態。有効な値：`Success` および `Fail`。
Code	String	エラーコード。このフィールドは、`State` が `Fail` の場合にのみ存在します。
Message	String	エラーの詳細な説明。`State` が `Fail` の場合にのみ提供されます。
MediaWorkflowExecution	MediaWorkflowExecution	メディアワークフローの実行に関する情報。

レスポンスフィールド

フィールド	型	説明	例
	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	メディアファイルのビットレート (Kbit/s 単位)。	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 内の対応するファイルはプライベート権限を持ちます。 Published：メディアは公開されています。OSS 内の対応するファイルはデフォルト権限を持ちます。	Published
Description	string	説明。値の長さは最大 1,024 バイトです。	A test video
Width	string	メディアファイルの幅 (ピクセル単位)。	1280
Size	string	メディアファイルのサイズ (バイト単位)。	379860
CoverURL	string	カバー URL。	http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png
RunIdList	object	メディアワークフロー実行インスタンスの ID。
RunId	array	メディアワークフロー実行インスタンスの ID。
	string	実行されたメディアワークフローインスタンスの ID。複数の 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

例

成功レスポンス

JSONJSON

{
  "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"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。