文档首页/ 媒体处理 MPC/ API参考/ 抽帧截图接口/ 查询截图任务
更新时间：2024-11-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询截图任务

功能介绍

查询截图任务状态。返回任务执行结果，包括状态、输入、输出等信息。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/thumbnails

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

task_id

否

Array of strings

截图服务接受任务后产生的任务ID。一次最多10个

status

否

String

任务状态。

取值如下：

  • WAITING: 等待启动

  • PROCESSING：截图中

  • SUCCEEDED：截图成功

  • FAILED：截图失败

  • CANCELED：已删除

start_time

否

String

起始时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效

end_time

否

String

结束时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效

page

否

Integer

分页编号。查询指定“task_id”时，该参数无效。

默认值：0。

size

否

Integer

每页记录数。查询指定“task_id”时，该参数无效。

取值范围：[1,100]。

默认值：10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Project_Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息, 与路径参数中的项目ID相同。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

x-language

否

String

客户端语言

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

task_array

Array of ThumbTask objects

截图任务组

is_truncated

Integer

查询结果是否被截取。

  • 1代表被截取，即还有结果未被返回，可以通过设置page和size参数继续查询。

  • 0代表未被截取，即所有结果已被返回。

total

Integer

查询结果的数量。
表5 ThumbTask

参数

参数类型

描述

task_id

String

任务ID。

截图服务接受任务后产生的任务ID。一次最多10个。

status

String

任务状态

create_time

String

起始时间。

格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。

end_time

String

结束时间。

格式为yyyymmddhhmmss。必须是与时区无关的UTC时间，指定task_id时该参数无效。

input

ObsObjInfo object

输入存储位置。

output

ObsObjInfo object

输出存储位置。

output_file_name

String

输出文件名。

user_data

String

用户数据。

description

String

任务描述。

thumbnail_info

Array of PicInfo objects

截图文件信息。
表6 ObsObjInfo

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

OBS桶所在的区域，且必须与使用的MPC区域保持一致。

object

String

OBS对象路径，遵守OSS Object定义。

  • 当用于指示input时，需要指定到具体对象。

  • 当用于指示output时，只需指定到转码结果期望存放的路径。

在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[

  • 正确示例: demo.srt

  • 错误示例: [demo.srt

file_name

String

文件名

  • 当指定了此参数时，输出的对象名为object/file_name。

  • 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。

在作为输出文件名时：

  • 在转封装场景有效，需要指定输出文件名称

  • 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数

  • 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息

  • 在截图场景无效

  • 在转动图场景无效

  • 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。
表7 PicInfo

参数

参数类型

描述

pic_name

String

截图文件名。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/{project_id}/thumbnails?task_id=7684

响应示例

状态码： 200

查询截图任务成功。

{
  "task_array" : [ {
    "task_id" : 7684,
    "status" : "SUCCEEDED",
    "create_time" : 20201118121333,
    "end_time" : 20201118121336,
    "input" : {
      "bucket" : "example-bucket",
      "location" : "region01",
      "object" : "example-input.ts"
    },
    "output" : {
      "bucket" : "example-bucket",
      "location" : "region01",
      "object" : "example-output/example-path"
    },
    "thumbnail_info" : [ {
      "pic_name" : "9.jpg"
    }, {
      "pic_name" : "5.jpg"
    } ]
  } ],
  "is_truncated" : 0,
  "total" : 1
}

状态码： 400

查询截图任务失败。

{
  "error_code" : "MPC.10212",
  "error_msg" : "Operation failed."
}

状态码

状态码

描述

200

查询截图任务成功。

400

查询截图任务失败。

错误码

请参见错误码。

父主题： 抽帧截图接口