- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 应用示例
- 自定义转码模板接口
- 自定义转码模板组接口
- 水印模板接口
- 媒资转码接口
- 转封装接口
- 转动图接口
- 视频解析接口
- 抽帧截图接口
- 独立加密接口
- 授权与配置接口
- 租户开通
- 自定义转码模板接口
- 自定义转码模板组接口
- 水印模板接口
- 媒资转码接口
- 转封装接口
- 转动图接口
- 视频解析接口
- 抽帧截图接口
- 独立加密接口
- 授权与配置接口
- 租户开通
- 自定义转码模板接口
- 自定义转码模板组接口
- 水印模板接口
- 媒资转码接口
- 转封装接口
- 转动图接口
- 视频解析接口
- 抽帧截图接口
- 独立加密接口
- 授权与配置接口
- 租户开通
- 自定义转码模板接口
- 自定义转码模板组接口
- 水印模板接口
- 媒资转码接口
- 转封装接口
- 转动图接口
- 视频解析接口
- 抽帧截图接口
- 独立加密接口
- 授权与配置接口
- 租户开通
- 自定义转码模板接口
- 自定义转码模板组接口
- 水印模板接口
- 媒资转码接口
- 转封装接口
- 转动图接口
- 视频解析接口
- 抽帧截图接口
- 独立加密接口
- 授权与配置接口
- 租户开通
- 附录
- 修订记录
- SDK参考
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询截图任务
功能介绍
查询截图任务状态。返回任务执行结果，包括状态、输入、输出等信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/thumbnails
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参考“获取项目ID”章节。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
否 |
Array of strings |
截图服务接受任务后产生的任务ID。一次最多10个 |
|
status |
否 |
String |
任务状态。 取值如下：
|
|
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。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_array |
Array of ThumbTask objects |
截图任务组 |
|
is_truncated |
Integer |
查询结果是否被截取。
|
|
total |
Integer |
查询结果的数量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
截图文件信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bucket |
String |
OBS的bucket名称。 |
|
location |
String |
OBS桶所在的区域，且必须与使用的MPC区域保持一致。 |
|
object |
String |
OBS对象路径，遵守OSS Object定义。
在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[
|
|
file_name |
String |
文件名，文件名长度不能超过180个字符。
在作为输出文件名时：
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
查询截图任务失败。 |
