You need to enable JavaScript to run this app.
导航
获取 AI 图像处理任务执行详情
最近更新时间:2025.03.28 15:37:07首次发布时间:2025.03.28 15:37:07
我的收藏
有用
有用
无用
无用

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

说明

仅支持查询结束时间在近 7 天的处理任务。

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetImageAIDetails接口名称。当前 API 的名称为 GetImageAIDetails
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
QueueIdString649a9dbc32**064d44cf5b0队列 ID,通过 CreateImageAITask 接口返回。
TaskIdString67174744adc54449623155b9任务 ID,通过 CreateImageAITask 接口返回,缺省时查询指定队列下全部的任务。
StartTimeLong1684713599查询的起始 Unix 时间戳,StartTime 与 EndTime 时间间隔最大不超过 7 天。
EndTimeInteger1685913599查询的结束 Unix 时间戳,StartTimeEndTime 时间间隔最大不超过 7 天。

Status

String

Pending

执行状态,填入多个时使用英文逗号分隔。取值如下所示:

  • Pending:排队中
  • Running:执行中
  • Success:执行成功
  • Fail:执行失败
SearchPtnStringtest返回图片 URL 或 URI 中包含该值的任务。默认为空,不传则返回所有任务。
LimitLong10分页条数,取值范围为 (0, 100]。
OffsetLong0分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。

返回参数

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

参数类型示例值描述
ExecInfoArray of ExecInfo-任务中每个条目的执行详情。
TotalLong2任务中包含的条目数。

ExecInfo

参数类型示例值描述
EntryIdString649a9332***80e9cc0a0ec条目 ID。
SubmitAtString2023-06-27 15:43:46提交时间。
StartAtString2023-06-27 15:44:11开始时间。
EndAtString2023-06-27 15:44:11结束时间。

Status

String

Fail

执行状态。取值如下所示:

  • Pending:排队中
  • Running:执行中
  • Success:执行成功
  • Fail:执行失败
ExecInputObject of ExecInput-执行输入。
ExecOutputObject of ExecOutput-执行输出。

ExecInput

参数类型示例值描述
ObjectKeyString2e39b35b98524100ae12b2ae07283cb2图片 URL 或 URI。

ExecOutput

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageAIDetails",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ExecInfo": [
            {
                "EntryId": "649a9332***80e9cc0a0ec",
                "SubmitAt": "2023-06-27 15:43:46",
                "StartAt": "2023-06-27 15:44:11",
                "EndAt": "2023-06-27 15:44:11",
                "Status": "Fail",
                "ExecInput": {
                    "ObjectKey": "2e39b35b98524100ae12b2ae07283cb2"
                },
                "ExecOutput": {
                    "ErrMsg": "解码图片要素失败",
                    "ErrCode": "615011",
                    "Output": "{\"ObjectKey\":\"veImageX-store/ai_super_resolution/67***/example.webp\",\"Size\":54509,\"Format\":\"webp\"}"
                }
            }
        ],
        "Total": 2
    }
}

错误码

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