获取视频信息列表_音视频管理_媒资管理_服务端API

描述

获取视频信息列表。

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

请求参数

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

返回参数

名称	类型	描述
RequestId	String	请求ID
VideoList	Video[]	视频信息列表
Total	Number	视频总条数

API示例

请求示例

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

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

返回示例

JSON格式

    {
        "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
        "Total" : 100,
        "VideoList":{
        "Video" [
            {
                "VideoId": "93ab850b4f6f44eab54b6e91d24d81d4",
                "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",
                "StorageLocation": "out-xxxxx-xxxxx.oss-cn-shanghai.aliyuncs.com"
            }
        ]
        }
    }

错误码

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

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

SDK示例

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