# 查询转动图任务 - ListAnimatedGraphicsTask #### 功能介绍 查询动图任务的状态。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-mpc/mpc_04_0047.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-mpc/mpc_04_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | mpc:animatedGraphicsTask:view | List | - | - | - | - | #### URI GET /v1/{project_id}/animated-graphics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-mpc/mpc_04_0064.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 否 | Array of strings | 任务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 | 任务列表 | 表5AnimatedGraphicsTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 任务ID | | status | String | 任务状态。 取值如下： - INIT：初始状态。 - WAITING：等待启动。 - PROCESSING：处理中。 - SUCCEED：处理成功。 - FAILED：处理失败。 - CANCELED：已取消。 | | create_time | String | 任务创建时间 | | start_time | String | 任务启动时间 | | end_time | String | 任务结束时间 | | error_code | String | 任务的返回码。 | | description | String | 错误描述 | | user_data | String | 用户数据。 | | input | [ObsObjInfo] object | 源文件信息 | | output | [ObsObjInfo] object | 输出文件信息 | | output_param | [AnimatedGraphicsOutputParam] object | 动图输出参数。 | 表6ObsObjInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bucket | String | OBS的bucket名称。 | | location | String | OBS桶所在的区域，且必须与使用的MPC区域保持一致。 | | object | String | OBS对象路径，遵守OSS Object定义。 - 当用于指示input时，需要指定到具体对象。 - 当用于指示output时，只需指定到转码结果期望存放的路径。 在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：\[ - 正确示例: demo.srt - 错误示例: \[demo.srt | | file_name | String | 文件名，文件名长度不能超过180个字符。 - 当指定了此参数时，输出的对象名为object/file_name。 - 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。 在作为输出文件名时： - 在转封装场景有效，需要指定输出文件名称 - 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数 - 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息 - 在截图场景无效 - 在转动图场景无效 - 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。 | 表7AnimatedGraphicsOutputParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 查询动图任务成功。 ``` { "total" : 1, "tasks" : [ { "task_id" : 30647, "error_code" : "MPC.10218", "status" : "SUCCEED", "create_time" : 20201119103652, "start_time" : 20201119103653, "end_time" : 20201119103708, "description" : "The task has completed.", "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output", "file_name" : "file_001.gif" }, "output_param" : { "format" : "gif", "width" : 100, "height" : 50, "start" : 0, "end" : 10000, "frame_rate" : 15 } } ] } ``` **状态码：400** 查询动图任务失败。 ``` { "error_code" : "MPC.10202", "error_msg" : "Invalid request parameter." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询动图任务成功。 | | 400 | 查询动图任务失败。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-mpc/ErrorCode.html)。