获取 AI 图像处理任务执行详情--veImageX-火山引擎

文档中心

立即注册

导航

获取 AI 图像处理任务执行详情

最近更新时间：2025.05.19 11:30:25首次发布时间：2025.03.28 15:37:07

指定任务 ID，查询 AI 图像处理任务的执行详情。

说明

仅支持查询结束时间在近 7 天的处理任务。
解析返回参数时，需要根据 workflow_template_id 的值来解析，以免解析失败。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间为 10 秒。
服务地址：本接口仅支持在中国区域调用，对应 region 为 cn-north-1，详情参看调用方法。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageAIDetails&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAIDetails`	接口名称。当前 API 的名称为 `GetImageAIDetails`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
QueueId	String	是	`649a9dbc32**064d44cf5b0`	队列 ID，通过 CreateImageAITask 接口返回。
TaskId	String	是	`67174744adc54449623155b9`	任务 ID，通过 CreateImageAITask 接口返回，缺省时查询指定队列下全部的任务。
StartTime	Long	是	`1684713599`	查询的起始 Unix 时间戳，`StartTime` 与 `EndTime` 时间间隔最大不超过 7 天。
EndTime	Long	是	`1685913599`	查询的结束 Unix 时间戳，`StartTime` 与 `EndTime` 时间间隔最大不超过 7 天。
Status	String	否	`Pending`	执行状态，填入多个时使用英文逗号分隔。取值如下所示： `Pending`：排队中 `Running`：执行中 `Success`：执行成功 `Fail`：执行失败
SearchPtn	String	否	`test`	返回图片 URL 或 URI 中包含该值的任务。默认为空，不传则返回所有任务。
Limit	Long	是	`10`	分页条数，取值范围为 (0, 100]。
Offset	Long	否	`0`	分页偏移量，默认为 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。
ServiceId	String	是	`5s****fo`	服务 ID。若 `DataType` 取值 `uri`，则提交的图片 URI 列表需在该服务内。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ExecInfo	Array of ExecInfo	`-`	任务中每个条目的执行详情。
Total	Long	`2`	任务中包含的条目数。

ExecInfo

参数	类型	示例值	描述
EntryId	String	`649a9332***80e9cc0a0ec`	条目 ID。
SubmitAt	String	`2023-06-27 15:43:46`	提交时间。
StartAt	String	`2023-06-27 15:44:11`	开始时间。
EndAt	String	`2023-06-27 15:44:11`	结束时间。
Status	String	`Fail`	执行状态。取值如下所示： `Pending`：排队中 `Running`：执行中 `Success`：执行成功 `Fail`：执行失败
ExecInput	Object of ExecInput	`-`	执行输入。
ExecOutput	Object of ExecOutput	`-`	执行输出。
WorkflowTemplateId	String	`system_workflow_product_img`	使用的 AI 图像处理模板 ID，参看 AI 图像处理模板页面获取模板 ID 对应的模板信息。

ExecInput

参数类型示例值描述

ObjectKey String 2e39b35b98524100ae12b2ae07283cb2 图片 URL 或 URI。

参数	类型	示例值	描述
ObjectKey	String	`2e39b35b98524100ae12b2ae07283cb2`	图片 URL 或 URI。
DataType	String	`url`	数据类型，取值如下所示： `uri`：指定 ServiceId 下存储 URI。 `url`：公网可访问的 URL。

DataType

String

url

数据类型，取值如下所示：

uri：指定 ServiceId 下存储 URI。
url：公网可访问的 URL。

ExecOutput

参数	类型	示例值	描述
Output	String	`{\"ObjectKey\":\"veImageX-store/ai_super_resolution/67***/example.webp\",\"Size\":54509,\"Format\":\"webp\"}`	AI 图像处理结果，是 JSON 压缩并转义后的字符串，仅当 `Status` 值为 `Success` 时，`Output` 有值。参看 AI 图像处理模板页面获取模板 ID 和参数信息，根据具体的工作流的说明进行解析。
ErrCode	String	`615011`	AI 图像处理失败错误码。仅当 `Status` 值为 `Fail` 时，`ErrCode` 有值。
ErrMsg	String	`解码图片要素失败`	AI 图像处理失败错误信息。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAIDetails&Version=2023-05-01&QueueId=649a9dbc32**064d44cf5b0&TaskId=67174744adc54449623155b9&StartTime=1684713599&EndTime=1685913599&Limit=10&ServiceId=5s****fo

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageAIDetails",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ExecInfo": [
            {
                "EntryId": "6803d6444f9a845e65f52693",
                "SubmitAt": "2025-04-20 00:58:44",
                "StartAt": "2025-04-20 00:59:23",
                "EndAt": "2025-04-20 00:59:55",
                "Status": "Success",
                "WorkflowTemplateId": "system_workflow_product_img",
                "ExecInput": {
                    "DataType": "url",
                    "ObjectKey": "https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_5fcf745d6eb0e6f40e2306b33ce96d2f.png"
                },
                "ExecOutput": {
                    "Output": "{\"GenImgs\":[{\"ObjectKey\":\"veImageX-store/6803aa651f5749dee5a6980f/生成图/6803d6444f9a845e65f52691/fb815ef244952134f83fc96a7730f27fc6a47faa1212cc0ee7a1b079289ba756.png\",\"Size\":481741,\"Format\":\"png\"},{\"ObjectKey\":\"veImageX-store/6803aa651f5749dee5a6980f/生成图/6803d6444f9a845e65f52691/f68106531b75e1e6add68cf9c07936ac0f2e4c40986bef5784f70e18d96c16d5.png\",\"Size\":553203,\"Format\":\"png\"}],\"DownloadObjectKey\":\"veImageX-store/6803aa651f5749dee5a6980f/原始图/6803d6444f9a845e65f52691/c9ab7cb0cb53be684a22ca6611bc22024732e37a2962a3996df900d86bdd67bd.png\"}",
                    "ErrCode": "",
                    "ErrMsg": ""
                }
            }
        ],
        "Total": 1
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。