文档首页 > > API参考> 抽帧截图接口> 查询截图任务

查询截图任务

分享
更新时间:2020/10/15 GMT+08:00

功能介绍

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

调试

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

URI

GET /v1/{project_id}/thumbnails

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

task_id

ARRAY

截图服务接受任务后产生的任务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 Bucket所在数据中心(OBS Location)。

object

String

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

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

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

file_name

String

文件名,仅用于转封装指定输出名称。

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

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

表7 PicInfo

参数

参数类型

描述

pic_name

String

截图文件名。

状态码为 400 时:

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码

状态码

描述

200

查询截图任务成功。

400

查询截图任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问