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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetVideoList

系统规定参数,取值:GetVideoList

CateId Long 7249287

视频分类ID。

Status String Uploading,Normal

视频状态,默认获取所有视频,多个可以用逗号分隔。取值包括:

  • Uploading(上传中)
  • UploadFail(上传失败)
  • UploadSucc(上传完成)
  • Transcoding(转码中)
  • TranscodeFail(转码失败)
  • Blocked(屏蔽)
  • Normal(正常)
PageNo Integer 1

当前页码,默认值为1

PageSize Integer 10

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

SortBy String CreationTime:Asc

结果排序。取值:

  • CreationTime:Desc(默认值):按创建时间倒序
  • CreationTime:Asc
StartTime String 2017-01-11T12:00:00Z

CreationTime(创建时间)的开始时间。

  • 为开区间(大于开始时间)。
  • 日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如,2017-01-11T12:00:00Z(为北京时间2017年1月11日20点0分0秒)。
EndTime String 2017-01-11T12:00:00Z

CreationTime的结束时间。

  • 为闭区间(小于等于结束时间)。
  • 日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如,2017-01-11T12:00:00Z(为北京时间2017年1月11日20点0分0秒)。
StorageLocation String out-xxxx.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。

CateId Long 78

视频分类ID。

CateName String 分类名

视频分类名称。

CoverURL String https://image.example.com/coversample.jpg

视频封面URL。

CreateTime String 2017-11-14 17:15:50

视频创建时间,为GMT时间。

CreationTime String 2017-11-14T09:15:50Z

视频创建时间,为UTC时间。

Description String 阿里云VOD视频描述

视频描述。

Duration Float 135.6

视频时长(秒)。

ModificationTime String 2017-11-14T09:15:50Z

视频更新时间,为UTC时间。

ModifyTime String 2017-11-14 17:15:50

视频更新时间,为GMT时间。

Size Long 10897890

视频源文件大小(字节)。

Snapshots List ["http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52"]

视频截图URL数组。

Status String Normal

视频状态。

StorageLocation String out-xxxx.oss-cn-shanghai.aliyuncs.com

视频存储区域。

Tags String 标签1, 标签2

视频标签,多个会用逗号分隔。

Title String 阿里云VOD视频标题

视频标题。

VideoId String 9ae2af636ca6*****c10412f44891fc

视频ID。

说明 下述请求示例中的“公共请求参数”详情,参见公共参数说明文档

示例

请求示例

http(s)://[Endpoint]/?Action=GetVideoList
&<公共请求参数>

正常返回示例

XML 格式

<GetVideoListResponse>
	  <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	  <Total>100</Total>
	  <VideoList>
		    <Video>
			      <VideoId>9ae2af636ca6*****c10412f44891fc</VideoId>
			      <Title>阿里云VOD视频标题</Title>
			      <Description>阿里云VOD视频描述</Description>
			      <Duration>135.6</Duration>
			      <CoverURL>https://image.example.com/coversample.jpg</CoverURL>
			      <Status>Normal</Status>
			      <CreationTime>2017-06-26T05:38:48Z</CreationTime>
			      <Size>10897890</Size>
			      <Snapshots>
				        <Snapshot>http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52</Snapshot>
				        <Snapshot>http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52</Snapshot>
			      </Snapshots>
			      <CateId>78</CateId>
			      <CateName>分类名</CateName>
			      <Tags>标签1, 标签2</Tags>
		    </Video>
	  </VideoList>
</GetVideoListResponse>

JSON 格式

{
	"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
	"Total" : 100,
	"VideoList":{
		"Video":[
			{
				"VideoId": "9ae2af636ca6*****c10412f44891fc",
				"Title": "阿里云VOD视频标题",
				"Description": "阿里云VOD视频描述",
				"Duration": 135.6,
				"CoverURL": "https://image.example.com/coversample.jpg",
				"Status": "Normal",
				"CreationTime": "2017-06-26T05:38:48Z",
				"Size": 10897890,
				"Snapshots": {
					"Snapshot":[
						"http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52", 
						"http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52"
					]
				},
				"CateId": 78,
				"CateName": "分类名",
				"Tags": "标签1, 标签2"
			}
		]
	}
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

VideoListExceededMax

The video list exceeded maximum.

400

翻页总条数超过最大限制。

InvalidVideo.NotFound

The video does not exist.

404

视频不存在。

SDK示例

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