查询指定队列下提交的各个 AI 图像处理任务的执行信息。
说明
解析返回参数时，需要根据 workflow_template_id 的值来解析，以免解析失败。
cn-north-1，详情参看调用方法。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetImageAITasks | 接口名称。当前 API 的名称为 GetImageAITasks。 |
| Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01。 |
ServiceId | String | 是 |
| 服务 ID。 |
| QueueId | String | 是 | 63db57e36**cce1ffee11bb1 | 队列 ID，通过 CreateImageAITask 接口返回。 |
| TaskId | String | 否 | 649b9d3****5537684010a7 | 任务 ID，通过 CreateImageAITask 接口返回，缺省时查询指定队列下全部的任务。 |
| Marker | String | 否 | 0 | 上一次查询返回的位置标记，作为本次查询的起点信息，默认值为空。 |
| Limit | Long | 否 | 10 | 单次查询列出的任务的个数，取值范围为 (0,1000]，默认值为 1000。 |
Status | String | 否 |
| 指定查询的任务状态，缺省时将查询全部状态的任务。取值如下所示：
|
| StartTime | Long | 是 | 1728921600 | 查询的起始 Unix 时间戳，StartTime 与 EndTime 时间间隔最大不超过 7 天。 |
| EndTime | Long | 是 | 1729612799 | 查询的结束 Unix 时间戳，StartTime 与 EndTime 时间间隔最大不超过 7 天。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| QueueId | String | 63db57e36**cce1ffee11bb1 | 指定的队列 ID。 |
| TaskInfo | Array of TaskInfo | - | AI 图像处理任务的各类信息。 |
HasMore | Boolean |
| 是否还有更多任务，取值如下所示：
|
| Marker | String | hkaiohwn**1WIO092WO | HasMore 取值为 true 时（即本次查询还有未列举到的任务时），Marker 应作为查询起始位置标记，您需要在下一次查询时传入该值。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TaskId | String | 649b9d3****5537684010a7 | 任务 ID。 |
Status | String |
| 任务的执行状态，取值如下所示：
|
| Total | Long | 1 | 任务中包含的条目数。 |
| Success | Long | 0 | 任务中执行成功的条目数。 |
| Fail | Long | 1 | 任务中执行失败的条目数。 |
Retry | Long |
| 任务中重试的条目数。 说明 当因系统内部原因导致的条目转码失败，系统将自动重试该条目，最大重试次数为 5。 |
| StartAt | String | 2024-10-22 13:28:16 | 任务的开始执行时间。 |
| EndAt | String | 2024-10-22 14:28:16 | 任务的结束执行时间。 |
| SubmitAt | String | 2024-10-22 13:26:46 | 任务的提交时间。 |
DataType | String |
| 数据类型，取值如下所示：
|
| WorkflowTemplateId | String | system_workflow_product_img | 使用的 AI 图像处理模板 ID，参看 AI 图像处理模板页面获取模板 ID 对应的模板信息。 |
| WorkflowParameter | String | {\"CreativeFlowId\":\"6803aa651f5749dee5a6980f\",\"Segmentation\":{\"Enable\":true,\"OutputFormat\":\"white_bg_image\"},\"ComprehensiveEnhance\":{\"Enable\":true,\"Mode\":1},\"ProductAIGC\":{\"Scene\":\"general\",\"PositivePrompt\":\"on a empty white table, kitchen, close to window, bright background, background blur, bright light, soft lighting, high quality\",\"OutputHeight\":512,\"OutputWidth\":512,\"BatchSize\":2,\"ProductRatio\":0.6}} | AI 图像处理模板参数，参看 AI 图像处理模板页面获取参数信息。 |
GET https://imagex.volcengineapi.com/?Action=GetImageAITasks&Version=2023-05-01&ServiceId=5s****fo&QueueId=63db57e36**cce1ffee11bb1&StartTime=1728921600&EndTime=1729612799
{ "ResponseMetadata": { "RequestId": "2025042003352006EBA****02911325000", "Action": "GetImageAITasks", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "Total": 1, "QueueId": "67d6bc8633f***8f36001583", "TaskInfo": [ { "TaskId": "6803d6444f9a***e65f52691", "Type": "Url", "DataType": "url", "WorkflowTemplateId": "system_workflow_product_img", "WorkflowParameter": "{\"CreativeFlowId\":\"6803aa651f5749dee5a6980f\",\"Segmentation\":{\"Enable\":true,\"OutputFormat\":\"white_bg_image\"},\"ComprehensiveEnhance\":{\"Enable\":true,\"Mode\":1},\"ProductAIGC\":{\"Scene\":\"general\",\"PositivePrompt\":\"on a empty white table, kitchen, close to window, bright background, background blur, bright light, soft lighting, high quality\",\"OutputHeight\":512,\"OutputWidth\":512,\"BatchSize\":2,\"ProductRatio\":0.6}}", "Status": "Done", "Total": 1, "Success": 1, "Fail": 0, "Retry": 0, "SubmitAt": "2025-04-20 00:58:44", "StartAt": "2025-04-20 00:58:44", "EndAt": "2025-04-20 00:59:58" } ], "Marker": "", "HasMore": false } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。
veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。