视频点播 VOD视频点播 VOD

更新时间:2021/09/18 GMT+08:00
分享

查询媒资列表

功能介绍

查询媒资列表,列表中的每一条记录包含媒资的概要信息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

asset_id

Array

媒资ID,最多同时查询10个。

status

Array

媒资状态,同时查询多个状态的媒资。

取值如下:

  • CREATING:上传中

  • FAILED:上传失败

  • CREATED:上传成功

  • PUBLISHED:已发布

  • TRANSCODING:转码中

  • TRANSCODE_SUCCEED:转码成功

  • TRANSCODE_FAILED:转码失败

  • THUMBNAILING:截图中

  • THUMBNAIL_SUCCEED:截图成功

  • THUMBNAIL_FAILED:截图失败

  • UN_REVIEW:未审核

  • REVIEWING:审核中

  • REVIEW_SUSPICIOUS :审核不过,待人工复审

  • REVIEW_PASSED:审核通过

  • REVIEW_FAILED:审核任务失败

  • REVIEW_BLOCKED:已屏蔽

start_time

String

起始时间。

格式为yyyymmddhhm mss。必须是与时区无关的UTC时间。

end_time

String

结束时间。

格式为yyyymmddhhm mss。必须是与时区无关的UTC时间。

category_id

Integer

分类ID。

tags

String

媒资标签。 单个标签不超过16个字节, 最多不超过16 个标签。 多个用英文逗号分隔,UTF8编码。

query_string

String

在媒资标题、 描述、分类名称中模糊查询的字符串。

media_type

Array

音视频文件的格式,支持多格式查询,最多不超过20个。

取值如下:

  • 视频文件格式:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG

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

page

Integer

分页编号。

默认值:0。

size

Integer

每页记录数。

取值范围:[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参数

参数

参数类型

描述

total

Integer

媒资总数

说明:

暂只能统计2万个媒资,若您需要查询具体的媒资总数,请提交工单申请。

assets

Array of AssetSummary objects

媒资列表

表5 AssetSummary

参数

参数类型

描述

asset_id

String

媒资ID。

title

String

媒资标题。长度不超过128个字节,UTF-8编码。

description

String

媒资描述。长度不超过1024个字节。

duration

Integer

媒资时长。

单位:秒。

size

Long

媒资大小。

单位:字节。

original_url

String

原始播放url。

category

String

媒资分类名称。

covers

Array of CoverInfo objects

封面信息。

create_time

String

媒资创建时间。

格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。

asset_status

String

媒资状态。

取值如下:

  • CREATING:上传中。

  • FAILED:上传失败。

  • CREATED:上传成功。

  • PUBLISHED:已发布。

  • DELETED:已删除。

transcode_status

String

转码状态。

取值如下:

  • UN_TRANSCODE:未转码。

  • WAITING_TRANSCODE:待转码

  • TRANSCODING:转码中。

  • TRANSCODE_SUCCEED:转码成功。

  • TRANSCODE_FAILED:转码失败。

thumbnail_status

String

截图状态。

取值如下:

  • UN_THUMBNAIL:未截图。

  • THUMBNAILING:截图中。

  • THUMBNAIL_SUCCEED:截图成功。

  • THUMBNAIL_FAILED:截图失败。

review_status

String

内容审核状态

取值如下:

  • UN_REVIEW:未审核。

  • REVIEWING:审核中。

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

  • REVIEW_PASSED:审核通过。

  • REVIEW_FAILED:审核失败。

  • REVIEW_BLOCKED:已屏蔽。

exec_desc

String

媒资的任务执行描述汇总。

示例:

  • asset_exec_desc: upload success,媒资任务执行描述信息。

  • transcode_exec_desc: transcode success,转码任务执行描述信息。

  • thumbnail_exec_desc: thumbnail failed,截图任务执行描述信息。

  • review_exec_desc: review pass,审核任务执行描述信息。

media_type

String

音视频文件的格式。

取值如下:

  • 视频文件格式:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG

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

表6 CoverInfo

参数

参数类型

描述

cover_url

String

封面文件的下载地址。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

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,
    "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

处理失败返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品