全部產品
Search

搜尋本產品

    ApsaraVideo VOD：GetVideoList

    文件中心

    ApsaraVideo VOD：GetVideoList

    更新時間：Jul 21, 2026

    取得影片資訊清單。

    介面說明

    本介面最多可取得指定篩選條件（如影片狀態、分類 ID 等）的前 5000 筆影音資料。建議限定 StartTime 和 EndTime 來分批取得資料。若需要查詢更多影音資料，甚至遍歷所有影音資訊，請參閱搜尋媒體資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:GetVideoList

    list

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    CateId

    integer

    否

    分類 ID。可透過以下方式取得：

    • 登入點播控制台，選擇配置管理 > 媒資管理配置 > 分類管理檢視分類 ID。

    • 透過建立分類介面建立分類時，分類 ID 為返回參數 CateId 的值。

    • 透過取得分類及子分類介面查詢分類時，為請求後返回參數 CateId 的值。

    781111
    Status

    string

    否

    影片狀態。支援取得多個狀態的影片，多個狀態之間使用半形逗號（,）分隔。取值：

    • Uploading：上傳中。

    • UploadFail：上傳失敗。

    • UploadSucc：上傳完成。

    • Transcoding：轉碼中。

    • TranscodeFail：轉碼失敗。

    • Checking：審核中。

    • Blocked：已封鎖。

    • Normal：正常。

    • ProduceFail：合成失敗。

    各影片狀態的具體含義解釋及相關限制，請參閱Status：影片狀態。

    Uploading,Normal
    PageNo

    integer

    否

    目前頁碼。預設值為 1。

    1
    PageSize

    integer

    否

    清單頁大小。預設值為 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 清單。由一個或多個自訂 ID 組成，多個 ID 之間使用半形逗號（,）分隔。最多支援 20 個。

    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：合成失敗。

    各視頻狀態的具體含義解釋及相關限制，請參見Status：視頻狀態。

    Normal
    CreationTime

    string

    音/視頻建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

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

    integer

    分類別識別碼。

    781111
    VideoId

    string

    音/視頻 ID。

    9ae2af636ca6c10412f44891fc****
    Tags

    string

    音/視頻標籤。多個用半形逗號（,）分隔。

    标签1, 标签2
    ModificationTime

    string

    視頻更新時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    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，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。

    123-123

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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