查询媒资信息 - ShowAssetMeta
功能介绍
查询媒资信息，支持指定媒资ID、分类、状态、起止时间查询。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
vod:asset:getInfo
List
assets *
-
-
-
URI
GET /v1.0/{project_id}/asset/info
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方法请参考获取项目ID |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
asset_id | 否 | Array of strings | 媒资id，最多同时查询10个媒资。 |
status | 否 | Array of strings | 媒资状态。 取值如下： |
transcodeStatus | 否 | Array of strings | 转码状态 取值如下： |
assetStatus | 否 | Array of strings | 媒资状态。 取值如下： |
start_time | 否 | String | 起始时间，查询指定“asset_id”时，该参数无效。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
end_time | 否 | String | 结束时间，查询指定“asset_id”时，该参数无效。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
category_id | 否 | Integer | 分类ID。 |
tags | 否 | String | 媒资标签。 单个标签不超过24个字节，最多不超过16个标签。 多个用逗号分隔，UTF8编码。 |
query_string | 否 | String | 在媒资标题、描述中模糊查询的字符串。 说明： 在一定数据量下，模糊查询存在效率问题，百万量级的媒资基数下，不建议使用该字段。 |
page | 否 | Integer | 分页编号，查询指定“asset_id”时，该参数无效。 若不设置或设置为null，默认查询首页，即第一页的数据，默认值：0。 |
size | 否 | Integer | 每页记录数，查询指定“asset_id”时，该参数无效。 取值范围：[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
参数 | 参数类型 | 描述 |
|---|---|---|
asset_info_array | Array of AssetInfo objects | 媒资信息列表。 |
is_truncated | Integer | 列表是否被截断。 取值如下： |
total | Integer | 查询媒资总数。 说明： 暂只能统计2万个媒资，若您需要查询具体的媒资总数，请提交工单人工申请。 |
参数 | 参数类型 | 描述 |
|---|---|---|
asset_id | String | VOD分配的媒资ID，仅支持查询，不支持修改。 |
is_multi_transcode | Boolean | 是否是多转码模式 |
status | String | 媒资状态。 取值如下： |
description | String | 媒资子状态或描述信息。 |
base_info | BaseInfo object | 媒资基本信息。 |
play_info_array | Array of PlayInfo objects | 转码文件的播放信息。 |
参数 | 参数类型 | 描述 |
|---|---|---|
title | String | 媒资标题。 长度不超过128个字节，UTF8编码。 |
video_name | String | 媒资文件名。 |
description | String | 媒资描述。 长度不超过1024个字节。 |
category_id | Long | 媒资分类id。 |
category_name | String | 媒资分类名称。 |
create_time | String | 媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
last_modified | String | 媒资最近修改时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 |
video_type | String | 音视频文件类型。 取值如下： |
tags | String | 媒资标签。 单个标签不超过24个字节，最多不超过16个标签。 多个用逗号分隔，UTF8编码。 |
meta_data | MetaData object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 |
video_url | String | 原始视频文件的访问地址。 |
sign_url | String | 原视频文件的OBS临时访问地址。仅调用查询指定媒资的详细信息接口时才返回具体值。 |
cover_info_array | Array of CoverInfo objects | 封面信息。 |
subtitle_info | Array of SubtitleInfo objects | 字幕信息数组 |
source_path | File_addr object | 媒资存储参数信息。 |
output_path | File_addr object | 媒资存储参数信息。 |
参数 | 参数类型 | 描述 |
|---|---|---|
url | String | 字幕文件的下载地址 |
id | Integer | 字幕文件id |
type | String | 字幕文件类型，目前暂只支持“SRT”和“VTT”。 |
language | String | 字幕文件语言种类 |
参数 | 参数类型 | 描述 |
|---|---|---|
bucket | String | OBS的bucket名称。 |
location | String | 桶所在的区域名， 如“华北-北京四”的区域名为“cn-north-4”，创建的桶所在区域必须和点播服务所在区域保持一致。 |
object | String | 文件的存储路径。 |
参数 | 参数类型 | 描述 |
|---|---|---|
play_type | String | 播放协议类型。 取值如下： |
group_id | String | 所属转码组Id |
group_name | String | 所属转码组名称 |
url | String | 播放URL。 |
encrypted | Integer | 标记流是否已被加密。 取值如下： 默认值：0。 |
meta_data | MetaData object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 |
参数 | 参数类型 | 描述 |
|---|---|---|
pack_type | String | 视频封装格式。 取值如下： |
codec | String | 视频编码格式。 取值如下： 说明： 如果codec返回unknown，说明不支持解析用户当前发送的音视频编码格式。 |
duration | Long | 视频时长，单位：秒。 若视频的原时长为非整数，则该字段值为原时长的向下取整。 若视频的原时长小于1，则该字段值为1。 |
duration_ms | Long | 视频时长，单位毫秒。 |
video_size | Long | 视频文件大小。 单位：字节。 |
width | Long | 视频宽度（单位：像素）。 |
hight | Long | 视频高度（单位：像素）。 |
height | Long | 视频高度（单位：像素） |
bit_rate | Long | 视频平均码率。 |
frame_rate | Long | 帧率（单位：帧每秒）。 |
quality | String | 清晰度。 取值如下： |
audio_channels | Integer | 音频的声道数。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
-
GET /v1.0/{project_id}/asset/info?asset_id=652c1e4085afeb22fdc256c6757d751b -
GET /v1.0/{project_id}/asset/info?asset_id=652c1e4085afeb22fdc256c6757d751b&asset_id=xxxxxx&asset_id=xxxxxx -
GET /v1.0/{project_id}/asset/info?start_time=20170725181000&end_time=20170726181000&page=0&size=20 查询（当前租户下）所有媒资：最近创建的10个，page为默认值0，size为默认值10
GET /v1.0/{project_id}/asset/info-
GET /v1.0/{project_id}/asset/info?page=1&size=20 -
GET /v1.0/{project_id}/asset/info?category_id=100
响应示例
状态码：200
处理成功返回。
{
"asset_info_array" : [ {
"asset_id" : "652c1e4085afeb22fdc256c6757d751b",
"status" : "PUBLISHED",
"description" : "Asset meta is published",
"is_multi_transcode" : false,
"base_info" : {
"title" : "okFLV.flv",
"video_name" : "okFLV.flv",
"description" : null,
"category_id" : -1,
"category_name" : "其他",
"create_time" : "20190704144303",
"last_modified" : "20190704144303",
"video_type" : "FLV",
"tags" : null,
"meta_data" : {
"pack_type" : null,
"codec" : "H.264",
"duration" : 244,
"duration_ms" : 244000,
"video_size" : 13682041,
"width" : 512,
"hight" : 288,
"height" : 288,
"bit_rate" : 448,
"frame_rate" : 30,
"quality" : null
},
"video_url" : "https://651.cdn-vod.huaweicloud.com/asset/652c1e4085afeb22fdc256c6757d751b/45c2493abe68de3dac7e98b0dadcf8ce.flv",
"sign_url" : "",
"cover_info_array" : [ {
"cover_url" : "https://651.cdn-vod.huaweicloud.com/asset/652c1e4085afeb22fdc256c6757d751b/cover/Cover0.jpg"
} ],
"subtitle_info" : [ ],
"source_path" : {
"bucket" : "obs-host",
"location" : "cn-north-4",
"object" : "1/okFLV.flv"
},
"output_path" : {
"bucket" : "obs-host",
"location" : "cn-north-4",
"object" : "output/652c1e4085afeb22fdc256c6757d751b/"
}
},
"play_info_array" : [ {
"play_type" : "hls",
"url" : "https://651.cdn-vod.huaweicloud.com/asset/652c1e4085afeb22fdc256c6757d751b/play_video/index.m3u8",
"encrypted" : 0,
"meta_data" : {
"pack_type" : null,
"codec" : "H.264",
"duration" : 0,
"duration_ms" : 0,
"video_size" : 0,
"width" : 0,
"hight" : 0,
"height" : 0,
"bit_rate" : 0,
"frame_rate" : 0,
"quality" : null
}
}, {
"play_type" : "hls",
"url" : "https://651.cdn-vod.huaweicloud.com/asset/652c1e4085afeb22fdc256c6757d751b/play_video/b5d498082bbcff7a2055041d803ae2f9_1.m3u8",
"encrypted" : 0,
"meta_data" : {
"pack_type" : null,
"codec" : "H.264",
"duration" : 205,
"duration_ms" : 205000,
"video_size" : 14669824,
"width" : 512,
"hight" : 288,
"height" : 288,
"bit_rate" : 534,
"frame_rate" : 0,
"quality" : null
}
} ]
} ],
"is_truncated" : 0,
"total" : 1
} 状态码：400
处理失败返回。
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
} 状态码
状态码 | 描述 |
|---|---|
200 | 处理成功返回。 |
400 | 处理失败返回。 |
错误码
请参见错误码。
