AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 视频点播 开发参考 服务端API/SDK API参考 API目录 媒资管理 音视频管理 GetVideoList - 获取音视频信息列表

GetVideoList - 获取音视频信息列表

更新时间：
产品详情
我的收藏

获取视频信息列表。

接口说明

本接口最多可获取指定筛选条件（如视频状态、分类 ID 等）的前 5000 条音视频。建议限定 StartTime 和 EndTime 来分批获取数据。若需要查询更多音视频，甚至遍历所有音视频信息，请参见搜索媒体信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:GetVideoList

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
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

返回参数

名称

类型

描述

示例值

object

返回结果。

Total

integer

音/视频总条数。

100
RequestId

string

请求 ID。

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

object

Video

array<object>

获取音/视频信息列表。最大支持获取前 5000 条。

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

分类 ID。

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

示例

正常返回示例

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetVideoInfos - 批量获取音视频信息下一篇：GetMezzanineInfo - 获取源文件信息