视频点播 VOD视频点播 VOD

文档首页> 视频点播 VOD> API参考> 媒资管理> 查询指定媒资的详细信息
更新时间:2021/09/18 GMT+08:00
分享

查询指定媒资的详细信息

功能介绍

查询指定媒资的详细信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1.0/{project_id}/asset/details

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

asset_id

String

媒资ID。

categories

Array

查询的信息类型。

  • 为空时表示查询所有信息。

  • 不为空时支持同时查询一个或者多个类型的信息,取值如下:

    • base_info:媒资基本信息。

    • transcode_info:转码结果信息。

    • thumbnail_info:截图结果信息。

    • review_info:审核结果信息。

请求参数

表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_id

String

媒资ID。

base_info

BaseInfo object

媒资基本信息。

transcode_info

TranscodeInfo object

转码生成文件信息。

说明:

仅当转码成功后才能查询到此信息,未转码、正在转码以及转码失败时,无此字段信息。

thumbnail_info

ThumbnailInfo object

截图信息。

说明:

仅当截图成功后才能查询到此信息,未截图、正在截图以及截图失败时,无此字段信息。

review_info

ReviewInfo object

审核信息数组。

说明:

仅当审核成功后才能查询到此信息,未审核、正在审核以及审核失败时,无此字段信息。

表5 BaseInfo

参数

参数类型

描述

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。

  • 音频文件:MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2。

tags

String

媒资标签。

单个标签不超过16个字节,最多不超过16个标签。

多个用逗号分隔,UTF8编码。

meta_data

MetaData object

视频的元数据信息。

经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。

video_url

String

原始视频文件的访问地址。

cover_info_array

Array of CoverInfo objects

封面信息。

subtitle_info

Array of SubtitleInfo objects

字幕信息数组

source_path

File_addr object

媒资存储参数信息。

output_path

File_addr object

媒资存储参数信息。

表6 MetaData

参数

参数类型

描述

codec

String

视频编码格式。

取值如下:

  • MPEG-2

  • MPEG-4

  • H.264

  • H.265

  • WMV

  • Vorbis

  • AAC

  • AC-3

  • AMR

  • APE

  • FLAC

  • MP3

  • MP2

  • WMA

  • PCM

  • ADPCM

  • WavPack

duration

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的倍数。

bit_rate

Long

视频平均码率。

frame_rate

Long

帧率(单位:帧每秒)。

取值如下:

  • FRAMERATE_AUTO = 1,

  • FRAMERATE_10 = 2,

  • FRAMERATE_15 = 3,

  • FRAMERATE_2397 = 4, // 23.97 fps

  • FRAMERATE_24 = 5,

  • FRAMERATE_25 = 6,

  • FRAMERATE_2997 = 7, // 29.97 fps

  • FRAMERATE_30 = 8,

  • FRAMERATE_50 = 9,

  • FRAMERATE_60 = 10

默认值:1。

单位:帧每秒。

quality

String

清晰度。

取值如下:

  • FULL_HD:超高清

  • HD:高清

  • SD:标清

  • FLUENT:流畅

  • AD:自适应

  • 2K

  • 4K

audio_channels

Integer

音频的声道数。

表7 CoverInfo

参数

参数类型

描述

cover_url

String

封面文件的下载地址。

表8 SubtitleInfo

参数

参数类型

描述

url

String

字幕文件的下载地址

id

Integer

字幕文件id

type

String

字幕文件类型

language

String

字幕文件语言种类

表9 File_addr

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。

object

String

文件的存储路径。

表10 TranscodeInfo

参数

参数类型

描述

template_group_name

String

转码模板组名称。

output

Array of Output objects

转码输出数组。

  • HLS或DASH格式:此数组的成员个数为n+1,n为转码输出路数。

  • MP4格式:此数组的成员个数为n,n为转码输出路数。

exec_desc

String

执行情况描述。

transcode_status

String

转码状态。

取值如下:

  • UN_TRANSCODE:未转码

  • WAITING_TRANSCODE:待转码

  • TRANSCODING:转码中

  • TRANSCODE_SUCCEED:转码成功

  • TRANSCODE_FAILED:转码失败

表11 Output

参数

参数类型

描述

play_type

String

协议类型。

取值如下:

  • hls

  • dash

  • mp4

url

String

播放URL。

encrypted

Integer

标记流是否已被加密。

取值如下:

  • 0:表示未加密。

  • 1:表示已被加密。

quality

String

清晰度。

取值如下:

  • FLUENT:流畅

  • SD:标清

  • HD:高清

  • FULL_HD:超清

meta_data

MetaData object

视频的元数据信息。

经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。

表12 ThumbnailInfo

参数

参数类型

描述

sample

Array of ThumbnailRsp objects

视频截图信息。

exec_desc

String

执行情况描述。

thumbnail_status

String

截图状态。

取值如下:

  • UN_THUMBNAIL:未截图

  • THUMBNAILING:截图中

  • THUMBNAIL_SUCCEED:截图成功

  • THUMBNAIL_FAILED:截图失败

表13 ThumbnailRsp

参数

参数类型

描述

offset

Integer

截图在视频中的时间偏移,单位为秒。

url

String

截图访问URL

表14 ReviewInfo

参数

参数类型

描述

suggestion

String

检测结果是否通过。

取值如下:

  • block:包含敏感信息,不通过。

  • pass:不包含敏感信息,通过。

  • review:需要人工复检。

当同时检测多个场景时,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

审核状态。

取值如下:

  • UN_REVIEW:未审核

  • REVIEWING:审核中

  • REVIEW_SUSPICIOUS:审核可疑,需要人工审核

  • REVIEW_PASSED:审核通过

  • REVIEW_FAILED:审核失败。

  • REVIEW_BLOCKED:已屏蔽。

表15 TextReviewRet

参数

参数类型

描述

suggestion

String

检测结果是否通过。

取值如下:

  • block:包含敏感信息,不通过。

  • pass:不包含敏感信息,通过。

  • review:需要人工复检。

politics

String

涉政敏感词列表

porn

String

涉黄敏感词列表

abuse

String

辱骂敏感词列表

表16 PictureReviewRet

参数

参数类型

描述

suggestion

String

检测结果是否通过。

取值如下:

  • block:包含敏感信息,不通过。

  • pass:不包含敏感信息,通过。

  • review:需要人工复检。

offset

Integer

截图在视频中的时间偏移值。封面不涉及此字段

单位:秒。

url

String

对应截图/封面的访问URL。

politics

Array of ReviewDetail objects

政治因素审核结果。

terrorism

Array of ReviewDetail objects

暴恐元素审核结果。

porn

Array of ReviewDetail objects

涉黄内容审核结果。

表17 ReviewDetail

参数

参数类型

描述

confidence

String

置信度。

取值范围:[0,1]。

label

String

每个检测结果的标签化说明。

  • politics场景:label为对应的政治人物信息。

  • terrorism场景: label为对应的暴恐元素(枪支、刀具、火灾等) 信息。

  • porn场景:label为对应的涉黄元素(涉黄、性感等)信息。

状态码: 400

表18 响应Body参数

参数

参数类型

描述

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" : {
      "play_type" : 0,
      "codec" : "H.264",
      "duration" : 131,
      "video_size" : 4942645,
      "width" : 1280,
      "hight" : 720,
      "bit_rate" : 173,
      "frame_rate" : 30
    },
    "video_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/5597e59de70722eaeb9b18c274e249b2.mp4",
    "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" : {
        "play_type" : 0,
        "codec" : "H.264",
        "duration" : 0,
        "video_size" : 0,
        "width" : 0,
        "hight" : 0,
        "bit_rate" : 0,
        "frame_rate" : 0
      }
    }, {
      "play_type" : "HLS",
      "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/视频点播\nVOD 视频_1_854X480_600_0.m3u8",
      "encrypted" : 0,
      "quality" : "SD",
      "meta_data" : {
        "play_type" : 0,
        "codec" : "H.264",
        "duration" : 130,
        "video_size" : 7976960,
        "width" : 854,
        "hight" : 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" : {
        "play_type" : 0,
        "codec" : "H.264",
        "duration" : 0,
        "video_size" : 0,
        "width" : 0,
        "hight" : 0,
        "bit_rate" : 0,
        "frame_rate" : 0
      }
    }, {
      "play_type" : "DASH",
      "encrypted" : 0,
      "quality" : "SD",
      "meta_data" : {
        "play_type" : 0,
        "codec" : "H.264",
        "duration" : 130,
        "video_size" : 7976960,
        "width" : 854,
        "hight" : 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

处理失败返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品