全部产品
云市场

获取视频信息列表

更新时间:2019-06-12 17:06:41

描述

获取视频信息列表。

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

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值:GetVideoList
StatusString视频状态。
默认获取所有视频,多个用逗号分隔,如:Uploading,Normal。取值范围:
  • Uploading(上传中)
  • UploadFail (上传失败)
  • UploadSucc(上传完成)
  • Transcoding(转码中)
  • TranscodeFail(转码失败)
  • Checking(审核中)
  • Blocked(屏蔽)
  • Normal(正常)
StartTimeStringCreationTime(创建时间)的开始时间。
  • 为开区间(大于开始时间)。
  • 日期格式按照ISO8601标准表示,使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如:2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。
EndTimeStringCreationTime的结束时间。
  • 为闭区间(小于等于结束时间)。
  • 日期格式按照ISO8601标准表示,使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如:2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。
CateIdLong 视频分类ID。
StorageLocationString存储地址。取值示例:out-xxxxx-xxxxx.oss-cn-shanghai.aliyuncs.com
PageNoLong 页号。
默认值:1
PageSizeLong分页大小。最大不超过100。
默认值:10
SortByString结果排序。取值范围:
  • CreationTime:Desc
  • CreationTime:Asc
默认值:CreationTime:Desc(即按创建时间倒序)

返回参数

名称类型描述
RequestId String请求ID
VideoListVideo[]视频信息列表
TotalNumber视频总条数

API示例

请求示例

  1. http://vod.cn-shanghai.aliyuncs.com/?Action=GetVideoList&Status=Normal&Format=JSON&<公共参数>

注意:示例中的“公共参数”参见 公共参数说明文档

返回示例

JSON格式

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "Total" : 100,
  4. "VideoList":{
  5. "Video" [
  6. {
  7. "VideoId": "93ab850b4f6f44eab54b6e91d24d81d4",
  8. "Title": "阿里云VOD视频标题",
  9. "Description": "阿里云VOD视频描述",
  10. "Duration": 135.6,
  11. "CoverURL": "https://image.example.com/coversample.jpg",
  12. "Status": "Normal",
  13. "CreationTime": "2017-06-26T05:38:48Z",
  14. "Size": 10897890,
  15. "Snapshots": {
  16. "Snapshot":[
  17. "http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52",
  18. "http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52",
  19. ...
  20. ]
  21. },
  22. "CateId": 78,
  23. "CateName": "分类名",
  24. "Tags": "标签1, 标签2",
  25. "StorageLocation": "out-xxxxx-xxxxx.oss-cn-shanghai.aliyuncs.com"
  26. }
  27. ]
  28. }
  29. }

错误码

下表列举了本接口特有的错误码,视频点播通用的错误码信息,参见 错误码表

错误代码错误信息HTTP 状态码说明
VideoListExceededMaxThe video list exceeded maximum.400翻页总条数超过最大限制。
InvalidVideo.NotFoundThe video does not exist.404视频不存在。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: