查询媒资列表 - ListAssetList
功能介绍
查询媒资列表,列表中的每一条记录包含媒资的概要信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1.0/{project_id}/asset/list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
asset_id |
否 |
Array of strings |
媒资ID,最多同时查询10个。 |
|
status |
否 |
Array of strings |
媒资状态,同时查询多个状态的媒资。 取值如下:
|
|
start_time |
否 |
String |
起始时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
|
end_time |
否 |
String |
结束时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
|
category_id |
否 |
Integer |
分类ID。 |
|
tags |
否 |
String |
媒资标签。 单个标签不超过24个字节, 最多不超过16个标签。 多个用英文逗号分隔,UTF8编码。 |
|
query_string |
否 |
String |
在媒资标题、 描述中模糊查询的字符串。
说明:
在一定数据量下,模糊查询存在效率问题,百万量级的媒资基数下,不建议使用该字段。
|
|
media_type |
否 |
Array of strings |
音视频文件的格式,支持多格式查询,最多不超过20个。 取值如下:
|
|
page |
否 |
Integer |
分页编号。 默认值:0。 |
|
size |
否 |
Integer |
每页记录数。 取值范围:[1,100]。 默认值:10。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
媒资总数
说明:
暂只能统计2万个媒资,若您需要查询具体的媒资总数,请提交工单申请。
|
|
assets |
Array of AssetSummary objects |
媒资列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
asset_id |
String |
VOD分配的媒资ID,仅支持查询,不支持修改。 |
|
title |
String |
媒资标题。长度不超过128个字节,UTF-8编码。 |
|
description |
String |
媒资描述。长度不超过1024个字节。 |
|
duration |
Integer |
媒资时长。 单位:秒。 |
|
duration_ms |
Long |
视频时长,单位毫秒。 |
|
size |
Long |
媒资大小。 单位:字节。 |
|
original_url |
String |
原始播放url。 |
|
category |
String |
媒资分类名称。 |
|
covers |
Array of CoverInfo objects |
封面信息。 |
|
create_time |
String |
媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
|
asset_status |
String |
媒资状态。 取值如下:
|
|
transcode_status |
String |
转码状态。 取值如下:
|
|
thumbnail_status |
String |
截图状态。 取值如下:
|
|
review_status |
String |
内容审核状态 取值如下:
|
|
exec_desc |
String |
媒资的任务执行描述汇总。 示例:
|
|
media_type |
String |
音视频文件的格式。 取值如下:
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询媒资列表
GET https://{endpoint}/v1.0/{project_id}/asset/list
响应示例
状态码:200
处理成功返回。
{
"total" : 1,
"assets" : [ {
"asset_id" : "67d1470893419bfcb9663103dd8a66ac",
"title" : "video.mp4",
"duration" : 60,
"duration_ms" : 60000,
"size" : 12881945,
"category" : "其他",
"covers" : [ {
"cover_url" : "https://355.cdn-vod.huaweicloud.com/asset/67d1470893419bfcb9663103dd8a66ac/cover/Cover0.jpg"
} ],
"create_time" : "20190625020756",
"asset_status" : "PUBLISHED",
"transcode_status" : "TRANSCODE_SUCCEED",
"thumbnail_status" : "UN_THUMBNAIL",
"review_status" : "UN_REVIEW",
"exec_desc" : "asset_exec_desc:Asset meta is\npublished;transcode_exec_desc:Transcode success;",
"media_type" : "MP4"
} ]
}
状态码:400
处理失败返回。
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
处理失败返回。 |
错误码
请参见错误码。