すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:RegisterMedia

    ドキュメントセンター

    ApsaraVideo VOD:RegisterMedia

    最終更新日:Jul 21, 2026

    メディアアセットを登録します。ApsaraVideo VOD に接続された独自の OSS バケットに保存されている既存のメディアファイルは、トランスコード中やスナップショット作成などの VOD 特徴を使用する前に、VOD で必須の関連データを生成するために登録する必要があります。

    操作説明

    • ApsaraVideo VOD に接続された OSS バケットに既に保存されているオーディオおよびビデオファイルについては、メディア ID を使用してこれらのファイルに対してトランスコード中、スナップショット作成、AI 処理などの操作を開始する前に、この操作を呼び出して VOD で必須の関連データを生成する必要があります。

    • 一度に最大 10 個の OSS メディアファイルを登録でき、単一のリクエストで送信されるすべてのメディアファイルは同じストレージの場所に対応している必要があります。

    • VOD を通じてアップロードされたメディアファイルの場合、トランスコーディングテンプレートグループ ID が指定されていないと、デフォルトのテンプレートグループがトランスコード中に使用されます。コントラストとして、メディアアセットの登録後、トランスコーディングテンプレートグループ 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":"ビデオ名"}]
    TemplateGroupId

    string

    任意

    トランスコーディングテンプレートグループ ID。以下のいずれかの方法で ID を取得できます。

    • ApsaraVideo VOD コンソール にログインし、構成管理 > メディア処理 > トランスコーディングテンプレートグループを選択して、トランスコーディングテンプレートグループ ID をビューします。

    • CreateTranscodeTemplateGroup 操作を呼び出した際の応答から TranscodeTemplateGroupId の値を取得します。

    • ListTranscodeTemplateGroup 操作を呼び出した際の応答から TranscodeTemplateGroupId の値を取得します。

    説明

    • トランスコード中が必須でない場合は、このパラメーターを VOD_NO_TRANSCODE (トランスコードなしテンプレートグループ) にセットしてください。そうしないと、ビデオステータスは UploadSucc となり、再生サービスを使用してビデオを再生できません。トランスコード中が必須な場合は、対応するトランスコーディングテンプレートグループ ID を指定してください。

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

    • このパラメーターは非同期タスクをトリガーします。送信後、タスクはバックグラウンドキューに入り、非同期で実行されます。

    ca3a8f6e49c87b65806709586****
    UserData

    string

    任意

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

    説明

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

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

    string

    任意

    ワークフロー ID。ApsaraVideo VOD コンソール にログインし、構成管理 > メディア処理 > ワークフロー管理を選択して、ワークフロー ID をビューします。

    説明

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

    • このパラメーターは非同期タスクをトリガーします。送信後、タスクはバックグラウンドキューに入り、非同期で実行されます。

    637adc2b7ba51a83d841606f8****
    EnableFirstFrameCover

    boolean

    任意

    GenerateThumbnail

    boolean

    任意

    RegisterMetadata

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

    名前タイプ必須説明
    FileURLStringはいソースファイルの URL。この値は GetMezzanineInfo 操作を呼び出すことで取得できます。
    URL は 1024 バイトを超えることはできません。ファイル名はグローバルに一意である必要があります。同じ名前のファイルを追加すると、一意のメディア ID に関連付けられます。URL の形式は、OSS バケットのパブリックエンドポイント + ObjectName (ファイル名) です。

    TitleStringはいタイトル。タイトルは 128 バイトを超えることはできません。UTF-8 エンコード。
    DescriptionStringいいえ説明。説明は 1024 バイトを超えることはできません。UTF-8 エンコード。
    TagsStringいいえタグ。各タグは 32 バイトを超えることはできません。最大 16 個のタグを指定できます。複数のタグはコンマ (,) で区切ります。UTF-8 エンコード。
    CoverURLStringいいえカバー URL。URL は 1024 バイトを超えることはできません。
    CateIdLongいいえカテゴリ ID。以下のいずれかの方法で ID を取得できます。
    ApsaraVideo VOD コンソール にログインし、構成管理 > メディアアセット管理 > カテゴリ管理を選択して、カテゴリ ID をビューします。
    AddCategory 操作を呼び出した際の応答から CateId の値を取得します。
    GetCategories 操作を呼び出した際の応答から CateId の値を取得します。







    ReferenceIdStringいいえカスタム 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。登録されたメディアファイルがオーディオまたはビデオファイルの場合、この値は ApsaraVideo 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****"
    }
  ]
}

    エラーコード

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

    変更履歴

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