获取视频信息列表。
接口说明
本接口最多可获取指定筛选条件(如视频状态、分类 ID 等)的前 5000 条音视频。建议限定 StartTime 和 EndTime 来分批获取数据。若需要查询更多音视频,甚至遍历所有音视频信息,请参见搜索媒体信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:GetVideoList | List |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CateId | long | 否 | 781111 | |
Status | string | 否 | 视频状态。支持获取多个状态的视频,多个状态之间使用半角逗号(,)分隔。取值:
各视频状态的具体含义解释及相关限制,请参见Status:视频状态。 | Uploading,Normal |
PageNo | integer | 否 | 当前页码。默认值为 1。 | 1 |
PageSize | integer | 否 | 列表页大小。默认值为 10,最大值为 100。 | 10 |
SortBy | string | 否 | 查询结果排序。取值:
| 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 |
返回参数
示例
正常返回示例
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"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |