すべてのプロダクト
Search

このプロダクト

    :RegisterMedia

    ドキュメントセンター

    :RegisterMedia

    最終更新日:Dec 09, 2025

    メディアアセットを登録します。ApsaraVideo VOD のトランスコーディングやスナップショット作成などの機能を利用するには、Object Storage Service (OSS) バケットからメディアファイルを登録する必要があります。登録により、VOD がファイルの処理に必要とする関連データが生成されます。

    操作説明

    • VOD と統合された OSS バケットに保存されているオーディオファイルとビデオファイルを登録する必要があります。このプロセスにより、VOD が必要とするデータが生成されます。その後、生成されたメディア ID を使用して、トランスコーディング、スナップショット作成、AI 処理などのジョブを開始できます。

    • 1 回のリクエストで最大 10 個の OSS メディアファイルを登録できます。リクエスト内のすべてのファイルは、同じストレージの場所にある必要があります。

    • VOD にアップロードされたファイルとは異なり、登録されたメディアアセットは自動的にトランスコーディングされません。ファイルをアップロードする際、トランスコーディングテンプレートグループ ID が指定されていない場合は、デフォルトのテンプレートグループを使用してトランスコーディングされます。登録されたアセットの場合、トランスコーディングをトリガーするには、トランスコーディングテンプレートグループ ID を指定する必要があります。

    • すでに登録されているファイルを登録しようとすると、この操作はその一意のメディア ID を返し、他のアクションは実行しません。

    • 登録するメディアファイルに有効なファイル拡張子が付いていることを確認してください。そうでない場合、登録は失敗します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vod:RegisterMedia

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegisterMetadatas

    string

    必須

    登録するメディアアセットのメタデータ。これは JSON 文字列です。一度に最大 10 個のメディアアセットのメタデータを指定できます。パラメーター構造の詳細については、以下の RegisterMetadata テーブルをご参照ください。

    [{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
    TemplateGroupId

    string

    任意

    トランスコーディングテンプレートグループの ID。ID は次の方法で取得できます：

    • ApsaraVideo VOD コンソールにログインします。ナビゲーションウィンドウで、[設定管理] > [メディア処理] > [トランスコーディングテンプレートグループ] を選択して ID を表示します。

    • AddTranscodeTemplateGroup 操作を呼び出します。レスポンスの TranscodeTemplateGroupId パラメーターの値がトランスコーディングテンプレートグループ ID です。

    • ListTranscodeTemplateGroup 操作を呼び出します。レスポンスの TranscodeTemplateGroupId パラメーターの値がトランスコーディングテンプレートグループ ID です。

    説明

    • メディアをトランスコーディングする必要がない場合は、このパラメーターを VOD_NO_TRANSCODE に設定します。そうしないと、ビデオのステータスは UploadComplete のままとなり、再生サービスを使用できません。メディアをトランスコーディングするには、目的のトランスコーディングテンプレートグループの ID を指定します。

    • WorkflowId と TemplateGroupId の両方を指定した場合、WorkflowId が優先されます。詳細については、「ワークフロー」をご参照ください。

    ca3a8f6e49c87b65806709586****
    UserData

    string

    任意

    カスタム設定。これは、メッセージコールバックなどの設定をサポートする JSON 文字列です。詳細については、「UserData」をご参照ください。

    説明

    この操作はコールバックをサポートしていません。このパラメーターでメッセージコールバックを設定しても、メディアアセットの登録後にコールバックメッセージは生成されません。後で登録されたアセットに対してトランスコーディングやスナップショット作成などのメディア処理を開始する際に、システムはコールバックアドレスを確認します。その特定のトランスコーディングまたはスナップショット作成リクエストの UserData でコールバックアドレスが指定されている場合、そのアドレスが使用されます。指定されていない場合は、登録時の UserData で指定されたコールバックアドレスが使用されます。

    {"Extend":{"localId":"****","test":"www"}}
    WorkflowId

    string

    任意

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

    説明

    WorkflowId と TemplateGroupId の両方を指定した場合、WorkflowId が優先されます。詳細については、「ワークフロー」をご参照ください。

    637adc2b7ba51a83d841606f8****

    RegisterMetadata

    登録するメディアアセットのメタデータを指定します。

    名前タイプ必須説明
    FileURLStringはいソースファイルの URL。この URL は GetMezzanineInfo 操作を呼び出すことで取得できます。
    URL の長さは最大 1,024 バイトです。ファイル名はグローバルに一意である必要があります。同じ名前のファイルを追加すると、そのファイルは一意のメディア ID に関連付けられます。URL は、OSS バケットのパブリックエンドポイントとオブジェクト名で構成されます。

    TitleStringはいタイトル。タイトルは最大 128 バイトの長さです。UTF-8 エンコードされている必要があります。
    DescriptionStringいいえ説明。説明は最大 1,024 バイトの長さです。UTF-8 エンコードされている必要があります。
    TagsStringいいえタグ。単一のタグは最大 32 バイトの長さです。最大 16 個のタグを指定できます。複数のタグはコンマ (,) で区切ります。タグは UTF-8 エンコードされている必要があります。
    CoverURLStringいいえサムネイルの URL。URL の長さは最大 1,024 バイトです。
    CateIdLongいいえカテゴリの ID。ID は次の方法で取得できます：
    ApsaraVideo VOD コンソールにログインします。ナビゲーションウィンドウで、[設定管理] > [メディア管理] > [カテゴリ] を選択して、カテゴリ ID を表示します。
    AddCategory 操作を呼び出します。レスポンスの CateId パラメーターの値がカテゴリ ID です。
    GetCategories 操作を呼び出します。レスポンスの CateId パラメーターの値がカテゴリ ID です。







    ReferenceIdStringいいえカスタム ID。小文字、大文字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。ID は 6～64 文字の長さで、各ユーザーに対して一意である必要があります。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエストの ID。

    14F43C5C-8033-448B-AD04F64E5098****
    FailedFileURLs

    array

    登録に失敗したファイルの URL のリスト。

    string

    登録に失敗したファイルの URL のリスト。

    ["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
    RegisteredMediaList

    array<object>

    このリクエストで正常に登録されたメディアアセットのリスト。これには、新規登録されたファイルと、すでに登録済みのファイルが含まれます。

    object

    登録の詳細。

    NewRegister

    boolean

    ファイルが新規登録されたか、すでに登録済みかを示します。

    • true：ファイルは新規登録されました。

    • false：ファイルはすでに登録済みでした。

    false
    FileURL

    string

    OSS ファイルの URL。

    http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4
    MediaId

    string

    VOD 内のメディアアセットの ID。登録されたメディアファイルがオーディオまたはビデオファイルの場合、この ID は VOD の VideoId です。

    d97af32828084d1896683b1aa38****

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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