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

查询截图任务

分享
更新时间: 2020/07/09 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

任务状态

start_time

String

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

end_time

String

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

page

Integer

分页编号,默认为0,指定task_id时该参数无效

size

Integer

每页记录数。范围[1,100],指定task_id时该参数无效

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码为 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

输出文件名。

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://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails?task_id=10211

  ```
* 多任务查询
  ```
    GET https://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails?task_id=10211&task_id=10212&……

  ```
* 复合查询
  ```
    //例一:
    GET https://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails
    //例二:
    GET https://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails?page=1&size=10
    //例三:
    GET https://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails?start_time=20170725181000&end_time= 20170726181000&status=SUCCEEDED&page=0&size=10
  ```

响应示例

状态码为 200 时:

{
  "task_array" : [ {
    "task_id" : "string",
    "status" : "NO_TASK",
    "create_time" : "string",
    "end_time" : "string",
    "input" : {
      "bucket" : "string",
      "location" : "string",
      "object" : "string",
      "file_name" : "string"
    },
    "output" : {
      "bucket" : "string",
      "location" : "string",
      "object" : "string",
      "file_name" : "string"
    },
    "output_file_name" : "string",
    "description" : "string",
    "thumbnail_info" : [ {
      "pic_name" : "string"
    } ]
  } ],
  "is_truncated" : 0,
  "total" : 0
}

状态码为 400 时:

{
  "error_code" : "string",
  "error_msg" : "string"
}

状态码

状态码

描述

200

查询截图任务成功。

400

查询截图任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品

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

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问