すべてのプロダクト
Search

このプロダクト

    :ListSnapshots

    ドキュメントセンター

    :ListSnapshots

    最終更新日:Dec 15, 2025

    スナップショットジョブを送信してキャプチャされたスナップショット、またはビデオのアップロード時にシステムによって生成されたサムネイルを照会します。

    操作説明

    ビデオに複数のスナップショットが存在する場合、この操作を呼び出して最新のスナップショットに関する情報を照会できます。

    今すぐお試しください

    この 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 署名を有効にしている場合にのみ有効になります。詳細については、「URL 署名の設定」をご参照ください。

    • 3,600 秒より小さい値を指定した場合、デフォルトで 3600 が使用されます。

    • スナップショットの URL が Object Storage Service (OSS) の URL である場合、このパラメーターの最大値は 2592000 (30 日間) です。これにより、オリジンでのリスクが軽減されます。

    3600
    PageSize

    string

    任意

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

    20
    PageNo

    string

    任意

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

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

    object

    スナップショットに関する情報。

    CreationTime

    string

    スナップショットジョブが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は 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"
        }
      ]
    }
  }
}

    エラーコード

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

    変更履歴

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