全部產品
Search

搜尋本產品

    ：ListSnapshots - 查詢視頻截圖資料

    文件中心

    ：ListSnapshots - 查詢視頻截圖資料

    更新時間：Dec 15, 2025

    調用本介面可以查詢通過視頻截圖作業產生的截圖，以及視頻上傳時系統產生的封面截圖。

    介面說明

    若一個視頻發起過多次視頻截圖，則本介面僅返回最近一次成功的截圖資料。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:ListSnapshots

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    VideoId

    string

    是

    視頻 ID。可通過以下方式擷取：

    d3e680e618708fbf2cae7cc931****
    SnapshotType

    string

    否

    返回的截圖類型。取值：

    • CoverSnapshot（預設值）：封面截圖。

    • NormalSnapshot：普通截圖。

    • SpriteSnapshot：雪碧截圖。

    • SpriteOriginSnapshot：雪碧圖原始圖。

    • WebVttSnapshot：WebVtt 截圖。

    CoverSnapshot
    AuthTimeout

    string

    否

    截圖訪問地址的到期時間。預設值：3600，最小值：3600，單位：秒。

    • 該參數只有開啟了 URL 鑒權才會生效。

    • 當設定的時間小於 3600 秒時，預設為3600 秒。

    • 如果返回的是 OSS 地址，為降低來源站點安全風險，最大值為 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

    截圖地址建置規則。

    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

    截圖訪問地址。

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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。