GetVideoList - 获取媒资信息列表

获取视频信息列表。

接口说明

本接口最多可获取指定筛选条件(如视频状态、分类 ID 等)的前 5000 条音视频。建议限定 StartTime 和 EndTime 来分批获取数据。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetVideoList
  • 全部资源
    *

请求参数

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

分类 ID。

781111
Statusstring

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

枚举值:
  • PrepareFail文件异常
  • UploadFail上传失败
  • UploadSucc上传完成
  • Transcoding转码
  • TranscodeFail转码失败
  • ProduceFail合成失败
  • Normal正常
  • Uploading上传中
  • Preparing文件生成中
  • Blocked屏蔽
  • Checking审核
Uploading,Normal
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
SortBystring

查询结果排序。取值:

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

当前页码。默认值为 1。

1
PageSizeinteger

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

20

返回参数

名称类型描述示例值
object

Schema of Response。

RequestIdstring

Id of the request。

******11-DB8D-4A9A-875B-275798******
Successstring

是否请求成功。取值:

  • true: 成功
  • false:失败
true
Codestring

返回码。

200
Totallong

符合条件的媒资总数。

163
MediaListarray<object>

媒资信息列表。

MediaListobject

媒资信息列表。

StorageLocationstring

存储地址。

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

视频状态。

枚举值:
  • PrepareFail文件异常
  • UploadFail上传失败
  • UploadSucc上传成功
  • Transcoding转码
  • TranscodeFail转码失败
  • ProduceFail合成失败
  • Normal正常
  • Uploading上传中
  • Preparing文件生成中
  • Blocked屏蔽
  • Checking审核
Normal
CreationTimestring

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

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

分类 ID。

3679
MediaIdstring

媒资 ID。

1c6ce34007d571ed94667630a6bc****
Tagsstring

标签列表。

标签1, 标签2
ModificationTimestring

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

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

分类名称。

分类1
Descriptionstring

描述。

阿里云VOD视频描述
AppIdstring

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

app-1000000
Sizelong

源文件大小。单位:字节。

10897890
CoverUrlstring

封面 URL。

http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****
Durationfloat

时长。单位:秒。

135.6
Titlestring

标题。

史上最牛音乐播放器
Snapshotsarray

视频截图 URL 数组。

Snapshotstring

视频截图 URL。

http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": "true",
  "Code": "200",
  "Total": 163,
  "MediaList": [
    {
      "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
      "Status": "Normal",
      "CreationTime": "2017-11-14T09:15:50Z",
      "CateId": 3679,
      "MediaId": "1c6ce34007d571ed94667630a6bc****",
      "Tags": "标签1, 标签2",
      "ModificationTime": "2017-11-14T09:16:50Z",
      "CateName": "分类1",
      "Description": "阿里云VOD视频描述",
      "AppId": "app-1000000",
      "Size": 10897890,
      "CoverUrl": "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****",
      "Duration": 135.6,
      "Title": "史上最牛音乐播放器",
      "Snapshots": [
        "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史