文档首页 > > API参考> 转动图接口> 查询转动图任务

查询转动图任务

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

功能介绍

查询动图任务的状态。

调试

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

URI

GET /v1/{project_id}/animated-graphics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

task_id

ARRAY

任务ID。一次最多10个

status

String

任务执行状态。

取值如下:

  • INIT:初始状态

  • WAITING:待启动

  • PREPROCESSING:处理中

  • SUCCEED:处理成功

  • 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参数

参数

参数类型

描述

total

Integer

任务总数

tasks

Array of AnimatedGraphicsTask objects

任务列表

表5 AnimatedGraphicsTask

参数

参数类型

描述

task_id

String

任务ID

status

String

任务状态。

取值如下:

  • INIT:初始状态。

  • WAITING:等待启动。

  • PROCESSING:处理中。

  • SUCCEED:处理成功。

  • FAILED:处理失败。

  • CANCELED:已取消。

create_time

String

任务创建时间

start_time

String

任务启动时间

end_time

String

任务结束时间

description

String

错误描述

input

ObsObjInfo object

源文件信息

output

ObsObjInfo object

输出文件信息

user_data

String

用户数据。

output_param

AnimatedGraphicsOutputParam object

动图输出参数。

表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 AnimatedGraphicsOutputParam

参数

参数类型

描述

format

String

动图格式,目前仅支持取值 gif

width

Integer

输出动图的宽。

取值范围:0,-1或[32,3840]之间2的倍数。

说明:
  • 若设置为-1, 则宽根据高来自适应,此时“height”不能取-1或0。

  • 若设置为0,则取原始视频的宽,此时“height”只能取0。

height

Integer

输出动图的高。

取值范围:0,-1或[32,2160]之间2的倍数。

说明:
  • 若设置为-1, 则高根据宽来自适应,此时“width”不能取-1或0。

  • 若设置为0,则取原始视频的高,此时“width”只能取0。

start

Integer

起始时间,单位:毫秒

end

Integer

结束时间。

单位:毫秒。

end、start差值最多60秒。

frame_rate

Integer

动图帧率。

取值范围:[1,75]

状态码为 400 时:

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/{project_id}/animated-graphics?task_id=30647

响应示例

状态码

状态码

描述

200

查询动图任务成功。

400

查询动图任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问