功能介绍
查询截图任务状态。返回任务执行结果，包括状态、输入、输出等信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/thumbnails
表12-9 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
表12-10 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时该参数无效
API 参考 12 抽帧截图接口
参数 是否必选 参数类型 描述
page 否 Integer 分页编号。查询指定
“task_id”时，该参数无效。
默认值：0。
size 否 Integer 每页记录数。查询指定
“task_id”时，该参数无效。
取值范围：[1,100]。
默认值：10。
请求参数
表12-11 请求 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
表12-12 响应 Body 参数
参数 参数类型 描述
task_array Array of ThumbTask objects
截图任务组
参数 参数类型 描述
is_truncated Integer 查询结果是否被截取。
● 1代表被截取，即还有结果未被返回，可以通 过设置page和size参数继续查询。
● 0代表未被截取，即所有结果已被返回。
total Integer 查询结果的数量。
表12-13 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_na
me String 输出文件名。
user_data String 用户数据。
description String 任务描述。
thumbnail_inf
o Array of PicInfo objects
截图文件信息。
表12-14 ObsObjInfo
参数 参数类型 描述
bucket String OBS的bucket名称。
API 参考 12 抽帧截图接口
参数 参数类型 描述
location String OBS桶所在的区域，且必须与使用的MPC区域保 持一致。
object String OBS对象路径，遵守OSS Object定义。
● 当用于指示input时,需要指定到具体对象。
● 当用于指示output时, 只需指定到转码结果期 望存放的路径。
file_name String 文件名，仅用于转封装指定输出名称。
● 当指定了此参数时，输出的对象名为object/
file_name 。
● 当不指定此参数时，输出的对象名为object/
xxx，其中xxx由MPC指定。
表12-15 PicInfo
参数 参数类型 描述
pic_name String 截图文件名。
状态码： 400
表12-16 响应 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" : "obs-apitest-01", "location" : "cn-north-5",
"object" : "ts/22.ts"
},
"output" : {
"bucket" : "obs-apitest-01", "location" : "cn-north-5",
"object" : "out_gamma/thumbnails/query_02"
},
"is_truncated" : 0, "total" : 1 }
状态码： 400 查询截图任务失败。
{ "error_code" : "MPC.10212", "error_msg" : "Operation failed."
}
您可以在API Explorer中调试该接口。
URI
DELETE /v1/{project_id}/thumbnails
API 参考 12 抽帧截图接口