首页 >视频点播 >API参考指南 >API目录 >媒资管理 >音视频管理 >GetVideoList - 获取音视频信息列表

GetVideoList - 获取音视频信息列表

调用GetVideoList获取视频信息列表。

接口说明

使用说明

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

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CateIdLong

分类ID。可通过以下方式获取:

  • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
  • 通过创建分类接口创建分类时,分类ID为返回参数CateId的值。
  • 通过获取分类及子分类接口查询分类时,为请求后返回参数CateId的值。
781111
Statusstring

视频状态。支持获取多个状态的视频,多个状态之间使用半角逗号(,)分隔。取值:

  • Uploading:上传中。
  • UploadFail:上传失败。
  • UploadSucc:上传完成。
  • Transcoding:转码中。
  • TranscodeFail:转码失败。
  • Blocked:屏蔽。
  • Normal:正常。
Uploading,Normal
PageNointeger

当前页码。默认值为1

1
PageSizeinteger

列表页大小。默认值为10,最大值为100

10
SortBystring

查询结果排序。取值:

  • CreationTime:Desc(默认值):按创建时间倒序。
  • CreationTime:Asc:按创建时间升序。
CreationTime:Asc
StartTimestring

CreationTime(创建时间)的开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2017-01-11T12:00:00Z
EndTimestring

CreationTime的结束时间,需晚于开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2017-01-11T12:59:00Z
StorageLocationstring

音/视频存储地址。

out-****.oss-cn-shanghai.aliyuncs.com

返回参数

名称类型描述示例值
object

返回结果。

Totalinteger

音/视频总条数。

100
RequestIdstring

请求ID。

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

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

object

音/视频信息详情。

StorageLocationstring

音/视频存储地址。

out-****.oss-cn-shanghai.aliyuncs.com
Statusstring

视频状态。取值:

  • Uploading:上传中。
  • UploadFail:上传失败。
  • UploadSucc:上传完成。
  • Transcoding:转码中。
  • TranscodeFail:转码失败。
  • Blocked:屏蔽。
  • Normal:正常。
Normal
CreationTimestring

音/视频创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

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

分类ID。

781111
VideoIdstring

音/视频ID。

9ae2af636ca6c10412f44891fc****
Tagsstring

音/视频标签。多个用半角逗号(,)分隔。

标签1, 标签2
ModificationTimestring

视频更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2017-11-14T09:16:50Z
CateNamestring

分类名称。

分类名称
Descriptionstring

音/视频描述。

阿里云VOD视频描述
AppIdstring

应用ID。默认取值:app-1000000

app-1000000
SizeLong

音/视频源文件大小。单位:字节。

10897890
CoverURLstring

音/视频封面URL。

https://example.aliyundoc.com/****.jpg
Durationnumber

音/视频时长。单位:秒。

135.6
Titlestring

音/视频标题。

阿里云VOD视频标题
Snapshotsarray

视频截图URL数组。

string

视频截图URL数组。

说明只有经过视频截图处理的视频,才会返回截图数据,否则返回为空。
["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetVideoList
&CateId=781111****
&Status=Uploading,Normal
&PageNo=1
&PageSize=10
&SortBy=CreationTime:Asc
&StartTime=2017-01-11T12:00:00Z
&EndTime=2017-01-11T12:59:00Z
&StorageLocation=out-****.oss-cn-shanghai.aliyuncs.com
&公共请求参数

正常返回示例

JSON格式

{
    "Total": 100,
    "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
    "VideoList": {
        "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": "[\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\",\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\",...]"
    }
}

XML格式

<GetVideoListResponse>
    <Total>100</Total>
    <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
    <VideoList>
        <StorageLocation>out-****.oss-cn-shanghai.aliyuncs.com</StorageLocation>
        <Status>Normal</Status>
        <CreationTime>2017-11-14T09:15:50Z</CreationTime>
        <CateId>781111****</CateId>
        <VideoId>9ae2af636ca6c10412f44891fc****</VideoId>
        <Tags>标签1, 标签2</Tags>
        <ModificationTime>2017-11-14T09:16:50Z</ModificationTime>
        <CateName>分类名称</CateName>
        <Description>阿里云VOD视频描述</Description>
        <AppId>app-1000000</AppId>
        <Size>10897890</Size>
        <CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>
        <Duration>135.6</Duration>
        <Title>阿里云VOD视频标题</Title>
        <Snapshots>["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]</Snapshots>
    </VideoList>
</GetVideoListResponse>

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
VideoListExceededMaxThe video list exceeded maximum.400翻页总条数超过最大限制。
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
阿里云首页 视频点播 相关技术圈