查询指定媒资的详细信息
功能介绍
查询指定媒资的详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1.0/{project_id}/asset/details
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
asset_id |
是 |
String |
VOD分配的媒资ID,仅支持查询,不支持修改。 |
categories |
否 |
Array |
查询的信息类型。 为空时表示查询所有信息。 不为空时支持同时查询一个或者多个类型的信息,取值如下:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
asset_id |
String |
VOD分配的媒资ID,仅支持查询,不支持修改。 |
base_info |
BaseInfo object |
媒资基本信息。 |
transcode_info |
TranscodeInfo object |
转码生成文件信息。
说明:
仅当转码成功后才能查询到此信息,未转码、正在转码以及转码失败时,无此字段信息。 |
thumbnail_info |
ThumbnailInfo object |
截图信息。
说明:
仅当截图成功后才能查询到此信息,未截图、正在截图以及截图失败时,无此字段信息。 |
review_info |
ReviewInfo object |
审核信息数组。
说明:
仅当审核成功后才能查询到此信息,未审核、正在审核以及审核失败时,无此字段信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
字幕文件类型 |
language |
String |
字幕文件语言种类 |
参数 |
参数类型 |
描述 |
---|---|---|
bucket |
String |
OBS的bucket名称。 |
location |
String |
桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。 |
object |
String |
文件的存储路径。 |
参数 |
参数类型 |
描述 |
---|---|---|
template_group_name |
String |
转码模板组名称。 |
output |
Array of Output objects |
转码输出数组。
|
exec_desc |
String |
执行情况描述。 |
transcode_status |
String |
转码状态。 取值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
play_type |
String |
协议类型。 取值如下:
|
url |
String |
播放URL。 |
group_id |
String |
所属转码组Id |
group_name |
String |
所属转码组名称 |
encrypted |
Integer |
标记流是否已被加密。 取值如下:
|
quality |
String |
清晰度。 取值如下:
|
meta_data |
MetaData object |
视频的元数据信息。 经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。 |
参数 |
参数类型 |
描述 |
---|---|---|
pack_type |
String |
视频封装格式。 取值如下:
|
codec |
String |
视频编码格式。 取值如下:
说明:
如果codec返回unknown,说明不支持解析用户当前发送的音视频编码格式。 |
duration |
Long |
视频时长。 若视频的原时长为非整数,则该字段值为原时长的向上取整。 |
video_size |
Long |
视频文件大小。 单位:字节。 |
width |
Long |
视频宽度(单位:像素)。
|
hight |
Long |
视频高度(单位:像素)。
|
height |
Long |
视频高度(单位:像素)[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] |
bit_rate |
Long |
视频平均码率。 |
frame_rate |
Long |
帧率(单位:帧每秒)。 取值如下:
默认值:1。 单位:帧每秒。 |
quality |
String |
清晰度。 取值如下:
|
audio_channels |
Integer |
音频的声道数。 |
参数 |
参数类型 |
描述 |
---|---|---|
sample |
Array of ThumbnailRsp objects |
视频截图信息,截图类型为间隔。 |
dots |
Array of ThumbnailRsp objects |
视频截图信息,截图类型为时间点。 |
quantity |
Array of ThumbnailRsp objects |
视频截图信息,截图类型为数量。 |
exec_desc |
String |
执行情况描述。 |
thumbnail_status |
String |
截图状态。 取值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
suggestion |
String |
检测结果是否通过。 取值如下:
说明:
当同时检测多个场景时,suggestion的值以最可能包含敏感信息的场景为准。即任一场景出现了block则总的suggestion为block,所有场景都pass时suggestion为pass,这两种情况之外则一定有场景需要review,此时suggestion为review。 |
text |
TextReviewRet object |
文本检测结果 |
cover |
Array of PictureReviewRet objects |
封面检测结果。 |
video |
Array of PictureReviewRet objects |
视频检测结果。 |
exec_desc |
String |
执行情况描述。 |
review_status |
String |
审核状态。 取值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
suggestion |
String |
检测结果是否通过。 取值如下:
|
politics |
String |
涉政敏感词列表 |
porn |
String |
涉黄敏感词列表 |
abuse |
String |
辱骂敏感词列表 |
参数 |
参数类型 |
描述 |
---|---|---|
suggestion |
String |
检测结果是否通过。 取值如下:
|
offset |
Integer |
截图在视频中的时间偏移值。封面不涉及此字段 单位:秒。 |
url |
String |
对应截图/封面的访问URL。 |
politics |
Array of ReviewDetail objects |
政治因素审核结果。 |
terrorism |
Array of ReviewDetail objects |
暴恐元素审核结果。 |
porn |
Array of ReviewDetail objects |
涉黄内容审核结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
confidence |
String |
置信度。 取值范围:[0,1]。 |
label |
String |
每个检测结果的标签化说明。
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
查询指定媒资详情
GET https://{endpoint}/v1.0/{project_id}/asset/details?asset_id={asset_id}
响应示例
状态码: 200
处理成功返回。
{ "asset_id" : "41cff636d5b12a51e7eb2838bbf45201", "base_info" : { "title" : "Avatar", "video_name" : "视频点播 VOD 视频.mp4", "description" : "Avatar, marketed as James Cameron's Avatar, is a 2009 American\nepic science fiction film directed, written, produced, and\nco-edited by James Cameron", "category_id" : -1, "category_name" : "其他", "create_time" : "20190612032250", "last_modified" : "20190613075030", "video_type" : "MP4", "tags" : "test1,test2", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 131, "video_size" : 4942645, "width" : 1280, "hight" : 720, "height" : 720, "bit_rate" : 173, "frame_rate" : 30 }, "video_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/5597e59de70722eaeb9b18c274e249b2.mp4", "sign_url" : "https://vod-bucket-57-cn-north-4.obs.cn-north-4.myhuaweicloud.com:443/05ab5cef408026f22f62c018de60cf2e/41cff636d5b12a51e7eb2838bbf45201 /5597e59de70722eaeb9b18c274e249b2.mp4?AWSAccessKeyId=MZH0LUL329N1SSXNB3S4&Expires=1652499973&Signature=ErjuGLGfrl9Lzqn0zaFDLibFKmU%3D", "cover_info_array" : [ { "cover_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/cover/Cover0.jpg" } ] }, "transcode_info" : { "template_group_name" : "system_template_group", "output" : [ { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.m3u8", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/视频点播VOD 视频_1_854X480_600_0.m3u8", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } }, { "play_type" : "DASH", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.mpd", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "DASH", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } } ], "exec_desc" : "Transcode success", "transcode_status" : "TRANSCODE_SUCCEED" } }
状态码: 400
处理失败返回。
{ "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
处理失败返回。 |
错误码
请参见错误码。