すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:GetVideoList

    ドキュメントセンター

    ApsaraVideo VOD:GetVideoList

    最終更新日:Jul 21, 2026

    音声および動画情報のリストを取得します。

    操作説明

    この操作は、指定されたフィルター条件（動画ステータスやカテゴリ ID など）に一致する最大 5000 件の音声および動画ファイルを取得します。StartTime および EndTime を指定して、データの取得をバッチで実行できます。より多くの音声および動画ファイルをクエリする場合、またはすべての音声および動画情報を走査する場合は、「メディア情報の検索」を参照してください。

    今すぐお試しください

    この 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:GetVideoList

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CateId

    integer

    任意

    カテゴリ ID。カテゴリ ID は、以下の方法で取得できます。

    • ApsaraVideo VOD コンソール にログインし、構成管理 > メディア管理設定 > カテゴリ管理 を選択してカテゴリ ID をビューに表示します。

    • CreateCategory 操作の呼び出し時に応答から CateId の値を取得します。

    • GetCategories 操作の呼び出し時に応答から CateId の値を取得します。

    781111
    Status

    string

    任意

    動画のステータス。複数のステータスを指定できます。複数のステータスはコンマ (,) で区切ります。有効な値:

    • Uploading: 動画はアップロード中です。

    • UploadFail: 動画のアップロードに失敗しました。

    • UploadSucc: 動画のアップロードが完了しました。

    • Transcoding: 動画はトランスコード中です。

    • TranscodeFail: 動画のトランスコードに失敗しました。

    • Checking: 動画はレビュー中です。

    • Blocked: 動画はブロックされています。

    • Normal: 動画は法線状態です。

    • ProduceFail: 動画の制作に失敗しました。

    動画のステータスと関連する使用制限の詳細については、「Status: 動画ステータス」を参照してください。

    Uploading,Normal
    PageNo

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。

    10
    SortBy

    string

    任意

    結果のソート順序。有効な値:

    • CreationTime:Desc (デフォルト): 作成時刻の降順でソートされます。

    • CreationTime:Asc: 作成時刻の昇順でソートされます。

    CreationTime:Asc。
    StartTime

    string

    任意

    CreationTime (作成時刻) に基づいてクエリを実行する時間範囲の開始時刻。時刻は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) で指定します。有効値: 開始時刻より後の時刻。

    2017-01-11T12:00:00Z
    EndTime

    string

    任意

    CreationTime に基づいてクエリを実行する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) で指定します。有効値: 開始時刻より後の時刻。

    2017-01-11T12:59:00Z
    StorageLocation

    string

    任意

    音声または動画ファイルのストレージの場所。

    out-****.oss-cn-shanghai.aliyuncs.com。
    ReferenceIds

    string

    任意

    カスタム ID のリスト。1 つ以上のカスタム ID をコンマ (,) で区切って指定します。最大値は 20 個の ID です。

    123-123,1234-1234

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    Total

    integer

    音声および動画ファイルの総数。

    100
    RequestId

    string

    リクエスト ID。

    25818875-5F78-4AF6-D7393642CA58****
    VideoList

    object

    Video

    array<object>

    音声および動画情報のリスト。最大 5000 エントリを返すことができます。

    array<object>

    音声または動画ファイルの詳細。

    StorageLocation

    string

    音声または動画ファイルのストレージアドレス。

    out-****.oss-cn-shanghai.aliyuncs.com
    Status

    string

    ビデオのステータス。有効な値：

    • Uploading：ビデオはアップロード中です。

    • UploadFail：ビデオのアップロードに失敗しました。

    • UploadSucc：ビデオはアップロードされました。

    • Transcoding：ビデオはトランスコーディング中です。

    • TranscodeFail：ビデオのトランスコーディングに失敗しました。

    • Checking：ビデオは審査中です。

    • Blocked：ビデオはブロックされています。

    • Normal：ビデオは通常の状態です。

    • ProduceFail：ビデオの生成に失敗しました。

    各ビデオステータスとその制限事項の詳細については、「ステータス：ビデオステータス」をご参照ください。

    Normal
    CreationTime

    string

    音声または動画ファイルが作成された時刻。時刻は UTC です。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。

    2017-11-14T09:15:50Z
    CateId

    integer

    カテゴリ ID。

    781111
    VideoId

    string

    音声または動画 ID。

    9ae2af636ca6c10412f44891fc****
    Tags

    string

    音声または動画ファイルのタグ。複数のタグはコンマ (,) で区切ります。

    标签1, 标签2
    ModificationTime

    string

    ビデオが最終更新された時刻。時刻は UTC です。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。

    2017-11-14T09:16:50Z
    CateName

    string

    カテゴリ名。

    分类名称
    Description

    string

    音声または動画ファイルの説明。

    阿里云VOD视频描述
    AppId

    string

    アプリケーション ID。デフォルト値：app-1000000。

    app-1000000
    Size

    integer

    ソース音声または動画ファイルのサイズ。単位：バイト。

    10897890
    CoverURL

    string

    音声または動画ファイルのカバー画像の URL。

    https://example.aliyundoc.com/****.jpg
    Duration

    number

    音声または動画ファイルの長さ。単位：秒。

    135.6
    Title

    string

    音声または動画ファイルのタイトル。

    阿里云VOD视频标题
    Snapshots

    object

    Snapshot

    array

    ビデオスナップショット URL の配列。

    string

    ビデオスナップショットの URL。

    説明

    スナップショットデータは、ビデオスナップショット機能で処理されたビデオに対してのみ返されます。それ以外の場合、このパラメーターは空です。

    http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****
    StorageClass

    string

    メディアアセットのストレージクラス。有効な値：

    • Standard：標準。

    • IA：低頻度アクセス。

    • Archive：アーカイブ。

    • ColdArchive：コールドアーカイブ。

    • SourceIA：ソースファイルの低頻度アクセス。

    • SourceArchive：ソースファイルのアーカイブ。

    • SourceColdArchive：ソースファイルのコールドアーカイブ。

    • Changing：メディアアセットのストレージクラスは変更中です。

    • SourceChanging：ソースファイルのストレージクラスは変更中です。

    Standard
    RestoreStatus

    string

    メディアアセットの解凍ステータス。有効な値：

    • Processing：メディアアセットは解凍中です。

    • Success：メディアアセットは解凍されました。

    • Failed：メディアアセットの解凍に失敗しました。

    Success
    RestoreExpiration

    string

    解凍されたメディアアセットの有効期限。

    2023-03-30T10:14:14Z
    UserData

    string

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

    {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
    ReferenceId

    string

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

    123-123

    例

    成功レスポンス

    JSONJSON

    {
  "Total": 100,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "VideoList": {
    "Video": [
      {
        "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
        "Status": "Normal",
        "CreationTime": "2017-11-14T09:15:50Z",
        "CateId": 781111,
        "VideoId": "9ae2af636ca6c10412f44891fc****",
        "Tags": "标签1, 标签2",
        "ModificationTime": "2017-11-14T09:16:50Z",
        "CateName": "分类名称",
        "Description": "阿里云VOD视频描述",
        "AppId": "app-1000000",
        "Size": 10897890,
        "CoverURL": "https://example.aliyundoc.com/****.jpg",
        "Duration": 135.6,
        "Title": "阿里云VOD视频标题",
        "Snapshots": {
          "Snapshot": [
            "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
          ]
        },
        "StorageClass": "Standard",
        "RestoreStatus": "Success",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
        "ReferenceId": "123-123"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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