CDN加速

批量获取视频列表信息

更新时间:2021-08-17 15:04:49

描述

通过该接口获取指定条件(上传时间、视频名称、视频ID、视频状态、指定分页)的已上传视频的信息。

请求说明

请求方式 Post/get
接口地址 http://api.cloudv.haplat.net/vod/videoManage/getVideoList
是否需要凭证 需要提供校验凭证

请求参数

参数名 类型 是否必填 描述
createUser string       否       创建用户。默认为空,允许传多个,以半角逗号隔开,不能以逗号开头或结尾,两个逗号之间的内容不为能为空或空白字符。该参数受权限限制,只能查询子账户或权限特殊配置的用户。
startTime string 查询起始时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询视频;
endTime string 查询截止时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询视频,小于当前查询时间;
videoName string 视频名称,用于筛选视频,支持模糊匹配;
videoId string 视频ID,用于筛选视频;
videoStatus int 视频状态,用于筛选视频。取值范围 :
  • 0(启用)
  • 1(屏蔽)
  • transcodeState string 未开启授权播放,视频的转码状态的取值范围 :
  • 1(已转码)
  • 2(未转码)
  • 3(转码中)
  • 4(转码失败)
  • 开启授权播放(视频加密)功能时的转码状态的取值范围 :
  • 1(已加密转码)
  • 2(非加密转码)
  • 3(转码中)
  • 4(转码失败)
  • 5(未转码)
  • videoClassification string 视频分类,各分类用“,”隔开。
    listOrder int 列表排列顺序,取值范围 :
  • 0(按创建时间降序排列)
  • 1(按创建时间升序排列)
  • 默认为0
    pageIndex int 取视频列表第几页,从1开始取值,默认为1。入参pageIndex和pageSize的乘积必须不大于100000。
    pageSize int 平均每页视频数量,取值范围1-50,默认为10。入参pageIndex和pageSize的乘积必须不大于100000。

    返回参数

    通用返回结果详见返回结果

    成功时返回的data参数的数据结构

    参数名 类型 描述
    videoTotal int 当前返回的视频列表信息的记录数,注意这里返回的记录数只是当前页的记录数。
    videoListInfo array 视频列表信息

    videoListInfo数组元素数据结构

    参数名 类型 描述
    videoName string 视频名称
    videoId string 视频ID
    createUser string 创建人
    encrypt int 是否加密转码文件。取值范围 :
  • 0(不加密)
  • 1(加密)
  • videoSize string 视频占用空间大小,视频及其转码后视频的总空间使用量
    videoDuration string 视频时长
    createTime string 视频创建时间
    uploadTime string 视频上传时间
    updateTime string 视频修改时间
    videoDescription string 视频描述
    videoClassification string 视频分类
    imageUrl string 视频封面URL
    publishDomain string 视频的发布域名
    playerName string 视频使用的播放器名称
    playerId string 视频使用的播放器ID
    videoState string 视频状态
    取值范围:
  • 0(启用)
  • 1(屏蔽)
  • transcodeState string 未开启授权播放,视频的转码状态的取值范围 :
  • 1(已转码)
  • 2(未转码)
  • 3(转码中)
  • 4(转码失败)
  • 开启授权播放(视频加密)功能时的转码状态的取值范围 :
  • 1(已加密转码)
  • 2(非加密转码)
  • 3(转码中)
  • 4(转码失败)
  • 5(未转码)
  • videoSourceCode int 视频来源
    取值范围:
  • 0(其他)
  • 1(上传)
  • 2(直播转录制)
  • 3(视频拉取)
  • 4(视频剪切)
  • 5(视频拼接)
  • 6(边缘拉流录制)
  • 10(通用版直播转录制)
  • 11(上传SDK)
  • 12(上传工具)
  • videoResolutions array 视频分辨率等信息

    videoResolutions数组元素数据结构
    参数详见 数据结构

    参数名 类型 描述
    clarity int 清晰度。取值范围 :
  • 1(原画)
  • 2(流畅)
  • 3(标清)
  • 4(高清)
  • 5(超清)
  • -99(录制文件)
  • serverType int 终端类型。取值范围 :
  • -1(源视频)
  • 0(PC端)
  • 1(移动端)
  • height int 高度
    width int 宽度
    fileSize long 文件大小(单位为bit)

    示例

    输入示例

    curl -X POST https://api.cloudv.haplat.net/vod/videoManage/getVideoList 
    -H "Content-Type: application/json; charset=utf-8" 
    -H "Host: api.cloudv.haplat.net" 
    <公共的头部参数>
    <自定义的头部参数>
    -d '{"videoName": "测试","pageIndex":"2","pageSize":"10"}'
    
    

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

    输出示例

    
    {
        "code": 200,
        "data": {
            "videoListInfo": [
                {
                    "createUser": "testUser",
                    "encrypt": 0,
                    "playerId": "DF2DAF233DDA",
                    "playerName": "基础播放器",
                    "imageUrl": "http://ovptest.haplat.net//live/201708/4101630234a74ee8864e56ea88e5d290_20170801171220/cloudv-cover/9B0F7BA8BCB9D056D4C24ADDBF821D10.jpg",
                    "publishDomain": "ovptest.haplat.net",
                    "transcodeState": "5",
                    "updateTime": "1501578874",
                    "uploadTime": "1501578866",
                    "videoClassification": "无",
                    "videoDescription": "",
                    "videoDuration": "36",
                    "videoId": "9B0F7BA8BCB9D056D4C24ADDBF821D10",
                    "videoName": "creattest_20170801171220",
                    "videoResolutions": [
                        {
                            "clarity": -99,
                            "fileSize": 5579209,
                            "height": 768,
                            "serverType": -1,
                            "width": 1364
                        },
                        {
                            "clarity": 1,
                            "fileSize": 5573951,
                            "height": 768,
                            "serverType": -1,
                            "width": 1364
                        }
                    ],
                    "videoSize": "11153160",
                    "videoSourceCode": 2,
                    "videoState": "0"
                },
                {
                    "createUser": "testUser",
                    "encrypt": 0,
                    "flashAutoPlay": 1,
                    "flashImageRatio": 0,
                    "flashPlayerId": "DF2DAF233DDA",
                    "flashPlayerName": "基础播放器",
                    "imageUrl": "http://ovptest.haplat.net//live/201708/4101630234a74ee8864e56ea88e5d290_20170801171104/cloudv-cover/E869FC95F3C7493ED56E8751C4AA7BEE.jpg",
                    "publishDomain": "ovptest.haplat.net",
                    "transcodeState": "5",
                    "updateTime": "1501578796",
                    "uploadTime": "1501578790",
                    "videoClassification": "无",
                    "videoDescription": "",
                    "videoDuration": "15",
                    "videoId": "E869FC95F3C7493ED56E8751C4AA7BEE",
                    "videoName": "creattest_20170801171104",
                    "videoResolutions": [
                        {
                            "clarity": -99,
                            "fileSize": 2533394,
                            "height": 768,
                            "serverType": -1,
                            "width": 1364
                        },
                        {
                            "clarity": 1,
                            "fileSize": 2531523,
                            "height": 768,
                            "serverType": -1,
                            "width": 1364
                        }
                    ],
                    "videoSize": "5064917",
                    "videoSourceCode": 2,
                    "videoState": "0"
                }
            ],
            "videoTotal": 2
        },
        "message": "操作成功"
    }
    
    

    错误码

    以下仅列出了接口业务逻辑相关的错误码,通用错误码详见 返回结果

    错误码 描述
    1512 开始时间输入有误,请输入:YYYY-MM-DD HH:mm:ss 的格式
    1513 结束时间输入有误,请输入:YYYY-MM-DD HH:mm:ss 的格式
    1519 确保开始时间小于结束时间
    1518 video输入包含特殊字符
    1504 videoId包含特殊字符
    1515 videoStatus只能输入0或者1
    1516 transcodeState只能输入1-5的整数
    1517 videoClassification只能包含中文,英文,字母,和逗号
    1320 listOrder只能为0或者1
    1321 listOrder不能为空
    1322 pageIndex只能为大于0的整数
    1323 pageSize只能为1-50的整数
    1324 pageIndex值过大