视频点播

产品文档

视频点播

帮助中心 > OpenAPI & SDK > 视频点播 > 查询视频信息列表

listVideos

描述

查询视频列表信息。 允许通过条件过滤查询,支持的过滤字段如下:

  • status[eq] 按视频状态精确查询
  • categoryId[eq] 按分类ID精确查询
  • videoId[eq] 按视频ID精确查询
  • name[eq] 按视频名称精确查询

请求方式

GET

请求地址

https://vod.jdcloud-api.com/v1/videos

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码;默认值为 1
pageSize Integer False 10 分页大小;默认值为 10;取值范围 [10, 100]
filters Filter[ ] False
sorts Sort[ ] False

Sort

名称 类型 是否必需 默认值 描述
name String False 排序属性名
direction String False 排序方向

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤器属性名
operator String False 过滤器操作符,默认值为 eq
values String[ ] True 过滤器属性值

返回参数

名称 类型 描述
result Result 查询视频列表信息结果
requestId String 请求ID

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalElements Integer 查询总数
totalPages Integer 总页数
content VideoObject[ ] 分页内容

VideoObject

名称 类型 描述
id String 视频ID
name String 视频名称
description String 视频描述
coverUrl String 封面图地址
status String 视频状态。取值范围:
transcoding - 转码中
transcode_failed - 转码失败
normal - 正常
uploaded - 上传完成(未转码)
blocked - 封禁
fileSize Long 文件大小,单位为 Byte
checksum String 文件MD5校验和
duration Long 视频时长
tags String[ ] 标签集合
categoryId Long 分类ID
categoryName String 分类名称
snapshots Snapshot[ ] 转码截图
createTime String 创建时间
updateTime String 修改时间

Snapshot

名称 类型 描述
imgId Long 截图ID
imgUrl String 截图URL
width Integer 截图宽度
height Integer 截图高度

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
404 Not found
500 Internal server error
503 Service unavailable

请求示例

GET

https://vod.jdcloud-api.com/v1/videos?pageNumber=1&pageSize=10&filters.1.name=name&filters.1.values.1=我的三体&filters.2.name=status&filters.2.values.1=normal&filters.2.operator=eq

返回示例

{
    "requestId": "bgvmivir54gddpgi764se9f4kfr7ge41", 
    "result": {
        "content": [
            {
                "categoryId": 0, 
                "categoryName": "未分类", 
                "checksum": "5149538c84c8e3a2c46acf29ad463328", 
                "coverUrl": "http://s3.cn-ite-1.jcloudcs.com/vod-storage-vvjdcloud/img/2019/7349/1/img6.jpg", 
                "createTime": "2019-03-29T11:44:18Z", 
                "description": "我的三体", 
                "duration": 10, 
                "fileSize": 5510872, 
                "id": "4fc583b4-d08a-457a-9ce4-8a59c5f474ac", 
                "name": "我的三体", 
                "snapshots": [
                    {
                        "height": "100", 
                        "imgId": "1", 
                        "imgUrl": "http://s3.cn-ite-1.jcloudcs.com/vod-storage-vvjdcloud/img/2019/7349/1/img6.jpg", 
                        "width": "300"
                    }
                ], 
                "status": "transcoding", 
                "tags": [
                    "Minecraft", 
                    "科幻", 
                    "刘慈欣"
                ], 
                "updateTime": "2019-03-29T11:45:51Z"
            }
        ], 
        "pageNumber": 1, 
        "pageSize": 10, 
        "totalElements": 92, 
        "totalPages": 10
    }
}
更新时间:2020-11-23 17:16:00
文档反馈 docs feedback