指定任务 ID,查询 AI 图像处理任务的执行详情。
说明
仅支持查询结束时间在近 7 天的处理任务。
cn-north-1
,详情参看调用方法。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | Integer | 是 | 1685913599 | 查询的结束 Unix 时间戳,StartTime 与 EndTime 时间间隔最大不超过 7 天。 |
Status | String | 否 |
| 执行状态,填入多个时使用英文逗号分隔。取值如下所示:
|
SearchPtn | String | 否 | test | 返回图片 URL 或 URI 中包含该值的任务。默认为空,不传则返回所有任务。 |
Limit | Long | 是 | 10 | 分页条数,取值范围为 (0, 100]。 |
Offset | Long | 否 | 0 | 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ExecInfo | Array of ExecInfo | - | 任务中每个条目的执行详情。 |
Total | Long | 2 | 任务中包含的条目数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 |
| 执行状态。取值如下所示:
|
ExecInput | Object of ExecInput | - | 执行输入。 |
ExecOutput | Object of ExecOutput | - | 执行输出。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ObjectKey | String | 2e39b35b98524100ae12b2ae07283cb2 | 图片 URL 或 URI。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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
{ "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 错误码。