すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:ListSnapshots

    ドキュメントセンター

    ApsaraVideo VOD:ListSnapshots

    最終更新日:Jul 21, 2026

    ビデオスナップショットジョブによって生成されたスナップショット、および動画のアップロード中にシステムによって自動生成されたサムネイルスナップショットを照会します。

    操作説明

    1 つの動画に対して複数のスナップショットジョブが開始されている場合、この操作は最新の成功したスナップショットジョブのデータのみを返します。

    今すぐお試しください

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VideoId

    string

    必須

    動画の ID。以下のいずれかの方法で動画の ID を取得できます。

    • ApsaraVideo VOD コンソール にログインし、メディアファイル > オーディオ/ビデオ を選択して動画の ID をビューに表示します。

    • アップロード URL と認証情報を取得するために呼び出しを行う CreateUploadVideo 操作の応答から動画の ID を取得します。

    • 動画をクエリするために呼び出しを行う SearchMedia 操作の応答から動画の ID を取得します。

    d3e680e618708fbf2cae7cc931****
    SnapshotType

    string

    任意

    返すスナップショットのタイプ。有効な値:

    • CoverSnapshot (デフォルト): サムネイルスナップショット。

    • NormalSnapshot: 法線スナップショット。

    • SpriteSnapshot: スプライト。

    • SpriteOriginSnapshot: スプライトの元画像。

    • WebVttSnapshot: WebVTT スナップショット。

    CoverSnapshot。
    AuthTimeout

    string

    任意

    スナップショットアクセス URL の有効時間。デフォルト値: 3600。最小値: 3600。単位: 秒。

    • このパラメーターは、URL 認証 が有効な場合にのみ効果があります。

    • 指定された値が 3600 秒未満の場合、デフォルト値の 3600 秒が使用されます。

    • 返される URL が OSS URL の場合、オリジンサーバーへのセキュリティリスクを軽減するため、最大値は 2592000 (30 日) です。

    3600
    PageSize

    string

    任意

    ページサイズ。デフォルト値: 20。最大値: 100。

    20
    PageNo

    string

    任意

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンス要素。

    RequestId

    string

    リクエスト ID。

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

    object

    ビデオスナップショットデータ。

    CreationTime

    string

    スナップショットジョブが作成された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。

    2017-12-20T12:23:45Z
    Regular

    string

    スナップショット URL を生成するためのルール。

    http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg
    Total

    integer

    スナップショットの総数。

    100
    JobId

    string

    スナップショットジョブの ID。

    ad90a501b1b9472374ad005046****
    Snapshots

    object

    Snapshot

    array<object>

    スナップショットの詳細。

    object

    スナップショットデータ。

    Index

    integer

    スナップショットのインデックス。

    1
    Url

    string

    スナップショットの URL。

    http://example.aliyundoc.com/snapshot/sample00001****.jpg

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "MediaSnapshot": {
    "CreationTime": "2017-12-20T12:23:45Z",
    "Regular": "http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg",
    "Total": 100,
    "JobId": "ad90a501b1b9472374ad005046****",
    "Snapshots": {
      "Snapshot": [
        {
          "Index": 1,
          "Url": "http://example.aliyundoc.com/snapshot/sample00001****.jpg"
        }
      ]
    }
  }
}

    エラーコード

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

    変更履歴

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