CDN加速

文档中心 云点播 批量获取音频列表信息

批量获取音频列表信息

更新时间:2022-01-10 11:44:47

描述

通过查询音频文件列表,按照上传时间倒序排序。支持分页去获取列表。

请求说明

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

请求参数

参数名 类型 是否必填 描述
createUser string 创建用户。默认为空,允许传多个,以半角逗号隔开,不能以逗号开头或结尾,两个逗号之间的内容不为能为空或空白字符。该参数受权限限制,只能查询子账户或权限特殊配置的用户。
startTime string 查询起始时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询音频;
endTime string 查询截止时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询音频,小于当前查询时间;
audioName string 音频名称,用于筛选音频,支持模糊匹配;
audioId string 音频ID,用于筛选音频;
listOrder int 列表排列顺序,取值范围 : · 0(按创建时间降序排列)· 1(按创建时间升序排列)默认为0
pageIndex int 取音频列表第几页,从1开始取值,默认为1。入参pageIndex和pageSize的乘积必须不大于100000。
pageSize int 平均每页音频数量,取值范围1-50,默认为10。入参pageIndex和pageSize的乘积必须不大于100000。

返回参数

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

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

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

audioListInfo数组元素数据结构

参数名 类型 描述
audioName string 音频名称
audioId string 音频ID
createUser string 创建人
audioSize string 音频占用空间大小,视频及其转码后视频的总空间使用量
audioDuration string 音频时长
url string 文件url
suffix string 文件后缀
createTime string 音频创建时间
uploadTime string 音频上传时间

示例

输入示例

curl -X POST  http://api.cloudv.haplat.net/vod/audioManage/getAudioList 
  -H 'content-type: application/json' 
  -H "Host: api.cloudv.haplat.net" 
  <公共的头部参数>
  <自定义的头部参数>
  -d '{"pageIndex":"1","pageSize":"3"}'

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

输出示例


{
"code": 200,
"data": {
"audioGetListResponseList": [
{
"audioSize": 2137289,
"audioName": "xxx1",
"createTime": 1639106397,
"audioId": "a25abe3b017d100069b7ee4600000000",
"createUser": "ovptest",
"audioDuration": 127.0,
"suffix": "mp3",
"uploadTime": 1639106397,
"url": "http://ovptest.haplat.net/audio/202112/a25abe3b017d100047ab42b200000000_1639106395/a25abe3b017d100047ab42b200000000.mp3"
},
{
"audioSize": 8954211,
"audioName": "xxx",
"createTime": 1636511945,
"audioId": "07b67c28017d1000b0c740cd00000000",
"createUser": "ovptest",
"audioDuration": 221.0,
"suffix": "mp3",
"uploadTime": 1636511945,
"url": "http://ovptest.haplat.net/audio/202111/07b67c28017d100027d6d67a00000000_1636511939/07b67c28017d100027d6d67a00000000.mp3"
}
],
"audioTotal": 2
},
"message": "操作成功"
}

错误码

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

| 错误码 | 描述 |

错误码 描述
1301 用户无权限
1004 参数错误,请确保所有必填项都已经填写
1000 开始时间不能大于结束时间
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!