メディアファイルを登録します。

使用上の注意

After you store an audio or video file in an Object Storage Service (OSS) bucket that is used for ApsaraVideo VOD, you can call the RegisterMedia operation to register the media file. メディアファイルの登録後、メディアファイルに関連付けられたメディアIDを使用して、ApsaraVideo VODでトランスコードジョブとスナップショットジョブを送信できます。 詳細については、「SubmitTranscodeJobs」および「SubmitSnapshotJob」をご参照ください。

注
  • 一度に同じ保存場所を持つ最大10個のOSSメディアファイルを登録できます。
  • ApsaraVideo VODコンソールを使用してメディアファイルをアップロードし、コード変換テンプレートグループIDを指定しない場合、ApsaraVideo VODはデフォルトのコード変換テンプレートグループを使用してメディアファイルをコード変換します。 However, if you do not specify a transcoding template group ID when you call the RegisterMedia operation, ApsaraVideo VOD does not automatically transcode the media file after the media file is registered. コード変換テンプレートグループIDを指定した場合、ApsaraVideo VODは指定されたコード変換テンプレートグループを使用してメディアファイルをコード変換します。
  • 登録するメディアファイルが以前に登録されている場合、この操作はメディアファイルに関連付けられている一意のメディアIDのみを返します。 さらなる処理は行われない。

QPS制限

この操作は、アカウントごとに1秒あたり最大50回呼び出すことができます。 If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. 詳細については、「ApsaraVideo VODのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 RegisterMedia

実行する操作です。 Set the value to RegisterMedia.

RegisterMetadatas String 必須 [{"FileURL":"https:// **** .oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","タイトル":"VideoName"}]

The metadata of the media file that you want to register. The value is a JSON string. You can specify the metadata for a maximum of 10 media files at a time. メディアファイルのメタデータの詳細については、このトピックのRegisterMetadataセクションを参照してください。

TemplateGroupId String 任意 ca3a8f6e49c87b65806709586 ****

The ID of the transcoding template group. You can use one of the following methods to obtain the ID of the transcoding template group:

  • ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[設定管理] > [メディア処理] > [トランスコードテンプレートグループ] を選択します。 On the Transcoding Template Groups page, you can view the ID of the transcoding template group.
  • コード変換テンプレートグループを作成するために呼び出したAddTranscodeTemplateGroup操作によって返されるTranscodeTemplateGroupIdパラメーターの値を表示します。
  • View the value of the TranscodeTemplateGroupId parameter returned by the ListTranscodeTemplateGroup operation that you called to query a transcoding template group.
注
  • If you do not need to transcode the media file, set the TemplateGroupId parameter to VOD_NO_TRANSCODE. Otherwise, an exception occurs during video playback. メディアファイルをトランスコードする必要がある場合は、トランスコードテンプレートグループのIDを指定します。
  • If both the WorkflowId and TemplateGroupId parameters are set, the value of the WorkflowId parameter takes effect. 詳細については、「ワークフロー」をご参照ください。
UserData String 任意 null

コールバック設定などのカスタム設定。 値はJSON文字列です。 詳細については、「リクエストパラメーター」トピックの「UserData: メディアアップロードのカスタム設定を指定する」セクションをご参照ください。

WorkflowId String 任意 637adc2b7ba51a83d841606f8 ****

ワークフローの ID を設定します。 ワークフローのIDを表示するには、ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[設定管理] > [メディア処理] > [ワークフロー] を選択します。

注 WorkflowIdパラメーターとTemplateGroupIdパラメーターの両方が設定されている場合、WorkflowIdパラメーターの値が有効になります。 詳細については、「ワークフロー」をご参照ください。

RegisterMetadata

次の表に、登録するメディアファイルのメタデータを示します。

パラメーター

データ型

必須／任意

説明

FileURL

String

必須

ソースファイルのOSS URL。 GetMezzanineInfo操作を呼び出して、ソースファイルのOSS URLを取得できます。

URLの長さは最大1,024バイトです。 ファイル名はグローバルに一意である必要があります。 登録するメディアファイルが以前に登録されている場合は、メディアファイルに関連付けられている一意のメディアIDが返されます。

タイトル

String

必須

メディアファイルのタイトル。 タイトルの長さは最大128バイトです。 値はUTF-8でエンコードする必要があります。

説明

String

任意

メディアファイルの説明。 説明の長さは最大1,024バイトです。 The value must be encoded in UTF-8.

タグ

String

任意

The one or more tags of the media file. 各タグの長さは最大32バイトです。 最大16個のタグを指定できます。 複数入力する場合は、コンマ (,) で区切ります。 値はUTF-8でエンコードする必要があります。

CoverURL

String

任意

The URL of the thumbnail. URLの長さは最大1,024バイトです。

CateId

Long

任意

メディアファイルのカテゴリID。 次のいずれかの方法を使用して、カテゴリIDを取得できます。

ApsaraVideo VODコンソールにログインします。 In the left-side navigation pane, choose Configuration Management > Media Management > Categories. カテゴリページでは、メディアファイルのカテゴリIDを表示できます。

カテゴリを作成するために呼び出したAddCategory操作によって返されるCateIdパラメーターの値を表示します。

カテゴリを照会するために呼び出したGetCategories操作によって返されるCateIdパラメーターの値を表示します。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 14F43C5C-8033-448B-AD04F64E5098 ****

リクエストの ID です。

FailedFileURL 文字列の配列 ["http:// **** .oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]

登録に失敗したメディアファイルのURL。

RegisteredMediaList Array of RegisteredMedia

登録されたメディアファイル (新規登録および繰り返し登録されたメディアファイルを含む) 。

NewRegister Boolean false

メディアファイルを新規登録するか、繰り返し登録するかを示します。 設定可能な値は以下のとおりです。

  • true: メディアファイルが新しく登録されました。
  • false: メディアファイルが繰り返し登録されます。
FileURL String http:// **** .oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4

The OSS URL of the media file.

MediaId String d97af32828084d1896683b1aa38****

The ID of the media file that is registered with ApsaraVideo VOD. 登録されたメディアファイルがオーディオファイルまたはビデオファイルの場合、ApsaraVideo VODによって返されるVideoIdパラメーターの値が有効になります。

例

リクエストの例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=RegisterMedia
&RegisterMetadatas=[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
&UserData={"Extend":{"localId":"****","test":"www"}}
&WorkflowId=637adc2b7ba51a83d841606f8****
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<RegisterMediaResponse>
    <RequestId>14F43C5C-8033-43E7-B48B-AD04F64E5098</RequestId>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4</FileURL>
        <NewRegister>true</NewRegister>
    </RegisteredMediaList>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4</FileURL>
        <NewRegister>false</NewRegister>
    </RegisteredMediaList>
    <FailedFileURL> http:// **** .oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4</FailedFileURL>
</RegisterMediaResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "14F43C5C-8033-43E7-B48B-AD04F64E5098",
  "RegisteredMediaList" : [ {
    "MediaId" : "d97af328280842229aed1896683b1aa38" 、
    "FileURL" : "http:// **** .oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4" 、
    "NewRegister" : true
  }, {
    "MediaId" : "d97af328280842229aed1896683b1aa38" 、
    "FileURL" : "http:// ***** .oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4" 、
    "NewRegister" : false
  } ],
  "FailedFileURL" : [ "http:// **** .oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。