# 查询媒资信息 - ShowAssetMeta #### 功能介绍 查询媒资信息，支持指定媒资ID、分类、状态、起止时间查询。 #### 接口约束 - 不推荐使用query_string参数进行模糊查询，推荐使用asset_id、start_time、end_time等参数进行精确查询。 因为携带query_string参数请求时，接口处理性能会下降，查询效率低。对应的接口流控详情，如下所示： - 除"华东-上海二"外其他Region的流控详情为，单租户接口流控是1500次/分钟，接口总体流控是1800次/分钟。 - "华东-上海二"Region的流控值，需提交工单咨询。 - 请求参数page和size的使用限制如下所示： - (page+1)\*size的值需不超过2万，即最多支持查询和展示2万条媒资信息。 - Page和Size两个参数影响单次分页查询结果数。特别注意：当这2个值都缺省时，本接口最多只返回10条查询结果。 最大支持反馈2万条搜索结果，超出部分不再支持查询。如果搜索结果量太大，建议使用更精细的筛选条件来减少搜索结果。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VOD/doc?api=ShowAssetMeta)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vod/vod_04_0012.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vod:asset:getInfo | List | assets \* | - | - | - | #### URI GET /v1.0/{project_id}/asset/info 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vod/vod_04_0211.html) | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | asset_id | 否 | Array of strings | 媒资id，最多同时查询10个媒资。 | | status | 否 | Array of strings | 媒资状态。 取值如下： - DELETED：已删除 - CANCELLED：上传取消 - SERVER_ERROR：上传失败（点播服务端故障） - UPLOAD_FAILED：上传失败（向OBS上传失败） - CREATING：创建中 - PUBLISHED：已发布 - TRANSCODING：待发布（转码中） - TRANSCODE_FAILED：待发布（转码失败） - TRANSCODE_SUCCEED：待发布（转码成功） - CREATED：待发布（未转码） | | transcodeStatus | 否 | Array of strings | 转码状态 取值如下： - TRANSCODING：转码中 - TRANSCODE_FAILED：转码失败 - TRANSCODE_SUCCEED：转码成功 - UN_TRANSCODE：未转码 - WAITING_TRANSCODE：等待转码 | | assetStatus | 否 | Array of strings | 媒资状态。 取值如下： - PUBLISHED：已发布 - CREATED：未发布 | | 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。 参数的使用限制，详见本节的"接口约束"。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_info_array | Array of [AssetInfo] objects | 媒资信息列表。 | | is_truncated | Integer | 列表是否被截断。 取值如下： - 1：表示本次查询未返回全部结果。 - 0：表示本次查询已经返回了全部结果。 | | total | Integer | 查询媒资总数。 说明： 暂只能统计2万个媒资，若您需要查询具体的媒资总数，请提交工单人工申请。 | 表5AssetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_id | String | VOD分配的媒资ID，仅支持查询，不支持修改。 | | is_multi_transcode | Boolean | 是否是多转码模式 | | status | String | 媒资状态。 取值如下： - UNCREATED：未创建（媒资ID不存在 ） - DELETED：已删除 - CANCELLED：上传取消 - SERVER_ERROR：上传失败（点播服务端故障） - UPLOAD_FAILED：上传失败（向OBS上传失败） - CREATING：创建中 - PUBLISHED：已发布 - WAITING_TRANSCODE：待发布（转码排队中） - TRANSCODING：待发布（转码中） - TRANSCODE_FAILED：待发布（转码失败） - TRANSCODE_SUCCEED：待发布（转码成功） - CREATED：待发布（未转码） - NO_ASSET：该媒资不存在 - DELETING：正在删除 - DELETE_FAILED：删除失败 - OBS_CREATING：OBS转存方式创建中 - OBS_CREATE_FAILED： OBS转存失败 - OBS_CREATE_SUCCESS： OBS转存成功 | | description | String | 媒资子状态或描述信息。 - 对于媒资异常场景，描述具体的异常原因。 - 对于正常场景，描述媒资的处理信息。 | | base_info | [BaseInfo] object | 媒资基本信息。 | | play_info_array | Array of [PlayInfo] objects | 转码文件的播放信息。 - HLS或DASH：此数组的成员个数为n+1，n为转码输出路数。 - MP4：此数组的成员个数为n，n为转码输出路数。 | 表6BaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 音视频文件类型。 取值如下： - 视频文件：MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV、WEBM - 音频文件：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 | | tags | String | 媒资标签。 单个标签不超过24个字节，最多不超过16个标签。 多个用逗号分隔，UTF8编码。 | | meta_data | [MetaData] object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 | | video_url | String | 原始视频文件的访问地址。 | | sign_url | String | 原视频文件的OBS临时访问地址。仅调用[查询指定媒资的详细信息](https://support.huaweicloud.com/api-vod/vod_04_0202.html)接口时才返回具体值。 | | cover_info_array | Array of [CoverInfo] objects | 封面信息。 | | subtitle_info | Array of [SubtitleInfo] objects | 字幕信息数组 | | source_path | [File_addr] object | 媒资存储参数信息。查询接口，仅媒资为托管时有返回值。 | | output_path | [File_addr] object | 媒资存储参数信息。查询接口，仅媒资为托管时有返回值。 | 表7CoverInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cover_url | String | 封面文件的下载地址。 | 表8SubtitleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | 字幕文件的下载地址 | | id | Integer | 字幕文件id | | type | String | 字幕文件类型，目前暂只支持"SRT"和"VTT"。 | | language | String | 字幕文件语言种类 | 表9File_addr | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bucket | String | OBS的bucket名称。 | | location | String | 桶所在的区域名， 如"华北-北京四"的区域名为"cn-north-4"，创建的桶所在区域必须和点播服务所在区域保持一致。 | | object | String | 文件的存储路径。 | 表10PlayInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | play_type | String | 播放协议类型。 取值如下： - hls - dash - mp4 | | group_id | String | 所属转码组Id | | group_name | String | 所属转码组名称 | | url | String | 播放URL。 | | encrypted | Integer | 标记流是否已被加密。 取值如下： - 0：表示未加密。 - 1：表示已被加密。 默认值：0。 | | meta_data | [MetaData] object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 | 表11MetaData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pack_type | String | 视频封装格式。 取值如下： - MP4 - TS - MOV - MXF - MPG - FLV - WMV - MP3 - WMA - APE - FLAC - AAC - AC3 - MMF - AMR - M4A - M4R - OGG - WAV - WV - MP2 - AVI - F4V - M4V - MPEG - HLS - DASH | | codec | String | 视频编码格式。 取值如下： - MPEG-2 - MPEG-4 - H.264 - H.265 - WMV - Vorbis - AAC - AC-3 - AMR - APE - FLAC - MP3 - MP2 - WMA - PCM - ADPCM - WavPack 说明： 如果codec返回unknown，说明不支持解析用户当前发送的音视频编码格式。 | | audio_codec | String | 音频编码格式。 须知：仅在2025/01/01之后创建的媒资元数据/转码产物包含该参数。 | | duration | Long | 视频时长，单位：秒。 若视频的原时长为非整数，则该字段值为原时长的向下取整。 若视频的原时长小于1，则该字段值为1。 | | duration_ms | Long | 视频时长，单位毫秒。 | | video_size | Long | 视频文件大小。 单位：字节。 | | width | Long | 视频宽度（单位：像素）。 - 编码为H.264的取值范围：\[32,3840\]之间2的倍数。 - 编码为H.265的取值范围：\[320,3840\]之间4的倍数。 | | hight | Long | 视频高度（单位：像素）。 - 编码为H.264的取值范围：\[32,2160\]之间2的倍数 。 - 编码为H.265的取值范围：\[240,2160\]之间4的倍数。 | | height | Long | 视频高度（单位：像素） | | bit_rate | Long | 视频平均码率。 | | frame_rate | Long | 帧率（单位：帧每秒）。 | | quality | String | 清晰度。 取值如下： - FULL_HD：超高清 - HD：高清 - SD：标清 - FLUENT：流畅 - AD：自适应 - 2K - 4K | | audio_channels | Integer | 音频的声道数。 | **状态码：400** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 - 单媒资ID查询 ``` GET /v1.0/{project_id}/asset/info?asset_id=652c1e4085afeb22fdc256c6757d751b ``` - 多媒资ID查询 ``` 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 ``` - 查询（当前租户下）所有媒资：最近创建的第21个到第40个 ``` 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", "audio_codec" : "AC-3", "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", "audio_codec" : "HEAAC", "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", "audio_codec" : "HEAAC", "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 | 处理失败返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vod/ErrorCode.html)。