调用GetVideoList获取视频信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetVideoList |
系统规定参数。取值:GetVideoList。 |
CateId | Long | 否 | 7249287 |
视频分类ID。 |
Status | String | 否 | Uploading,Normal |
视频状态。默认获取所有视频,多个使用英文逗号(,)分隔。取值包括:
|
PageNo | Integer | 否 | 1 |
当前页码。默认值为1。 |
PageSize | Integer | 否 | 10 |
列表页大小,可选。默认值为10,最大值为100。 |
SortBy | String | 否 | CreationTime:Asc |
结果排序。取值:
|
StartTime | String | 否 | 2017-01-11T12:00:00Z |
CreationTime(创建时间)的开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
EndTime | String | 否 | 2017-01-11T12:59:00Z |
CreationTime的结束时间。需晚于开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
StorageLocation | String | 否 | out-****.oss-cn-shanghai.aliyuncs.com |
视频文件的存储区域。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 25818875-5F78-4A*****F6-D7393642CA58 |
请求ID。 |
Total | Integer | 100 |
视频总条数。 |
VideoList | Array of Video |
获取视频信息列表。最大支持获取前5000条。 |
|
Video | |||
AppId | String | app-1000000 |
应用ID。默认取值:app-1000000。 |
CateId | Long | 78 |
视频分类ID。 |
CateName | String | 分类名 |
视频分类名称。 |
CoverURL | String | https://image.example.com/****.jpg |
视频封面URL。 |
CreationTime | String | 2017-11-14T09:15:50Z |
视频创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
Description | String | 阿里云VOD视频描述 |
视频描述。 |
Duration | Float | 135.6 |
视频时长。单位:秒。 |
ModificationTime | String | 2017-11-14T09:16:50Z |
视频更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
Size | Long | 10897890 |
视频源文件大。单位:字节。 |
Snapshots | List | ["http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52"] |
视频截图URL数组。 |
Status | String | Normal |
视频状态。默认获取所有视频,多个使用英文逗号(,)分隔。取值包括:
|
StorageLocation | String | out-****.oss-cn-shanghai.aliyuncs.com |
视频存储地域。 |
Tags | String | 标签1, 标签2 |
视频标签。多个用英文逗号(,)分隔。 |
Title | String | 阿里云VOD视频标题 |
视频标题。 |
VideoId | String | 9ae2af636ca6*****c10412f44891fc |
视频ID。 |
示例
请求示例
https://vod.aliyuncs.com/?Action=GetVideoList
&<公共请求参数>
正常返回示例
XML
格式
<GetVideoListResponse>
<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
<Total>100</Total>
<VideoList>
<Video>
<Status>Normal</Status>
<Description>阿里云VOD视频描述</Description>
<VideoId>9ae2af636ca6*****c10412f44891fc</VideoId>
<Size>10897890</Size>
<Title>阿里云VOD视频标题</Title>
<ModificationTime>2017-11-14T09:16:50Z</ModificationTime>
<Duration>135.6</Duration>
<CateName>分类名</CateName>
<CateId>78</CateId>
<AppId>app-1000000</AppId>
<CreationTime>2017-11-14T09:15:50Z</CreationTime>
<CoverURL>https://image.example.com/****.jpg</CoverURL>
<StorageLocation>out-****.oss-cn-shanghai.aliyuncs.com</StorageLocation>
<Tags>标签1, 标签2</Tags>
</Video>
<Video>
<Snapshots>
<Snapshot>["http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52"]</Snapshot>
</Snapshots>
</Video>
</VideoList>
</GetVideoListResponse>
JSON
格式
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"Total": "100",
"VideoList": {
"Video": [{
"Status": "Normal",
"Description": "阿里云VOD视频描述",
"VideoId": "9ae2af636ca6*****c10412f44891fc",
"Size": "10897890",
"Title": "阿里云VOD视频标题",
"ModificationTime": "2017-11-14T09:16:50Z",
"Duration": "135.6",
"CateName": "分类名",
"CateId": "78",
"AppId": "app-1000000",
"CreationTime": "2017-11-14T09:15:50Z",
"CoverURL": "https://image.example.com/****.jpg",
"StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
"Tags": "标签1, 标签2"
}, {
"Snapshots": {
"Snapshot": "[\"http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52\",\"http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52\"]"
}
}]
}
}
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 |
错误信息 |
HTTP 状态码 |
说明 |
---|---|---|---|
VideoListExceededMax |
The video list exceeded maximum. |
400 |
翻页总条数超过最大限制。 |
InvalidVideo.NotFound |
The video does not exist. |
404 |
视频不存在。 |
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见:
在文档使用中是否遇到以下问题
更多建议
匿名提交