获取任务执行详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取任务执行详情

最近更新时间：2024.11.29 16:12:07首次发布时间：2023.12.25 16:48:05

本接口支持您通过指定任务队列 ID 和查询时间段获取当前队列的转码任务详情。

说明

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageTranscodeDetails`	接口名称。当前 API 的名称为 `GetImageTranscodeDetails`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
QueueId	String	是	`649a9dbc32**064d44cf5b0`	队列 ID，您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。
TaskId	String	否	`67174744adc54449623155b9`	任务 ID，缺省情况下查询指定队列下所有任务详情。您可通过调用 GetImageTranscodeTasks获取指定队列的全部任务 ID。
Region	String	否	`cn`	队列所在地区。默认当前地区为 cn。
StartTime	Long	是	`1684713599`	任务提交的起始 Unix 时间戳 `StartTime`与`EndTime`时间间隔最大不超过 7 天。
EndTime	Long	是	`1685913599`	任务提交的截止 Unix 时间戳 `StartTime`与`EndTime`时间间隔最大不超过 7 天。
Status	String	否	`Pending`	执行状态，填入多个时使用英文逗号分隔。取值如下所示： `Pending`：排队中 `Running`：执行中 `Success`：执行成功 `Fail`：执行失败
SearchPtn	String	否	`tos-cn-i-5sq****fo/test`	返回图片 url 或 uri 中包含该值的任务。默认为空，不传则返回所有任务。
Limit	Long	是	`10`	分页条数，取值范围为(0, 100]。
Offset	Long	否	`0`	分页偏移量，默认为 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。

返回参数

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

参数	类型	示例值	描述
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	`-`	执行输出

ExecInput

参数	类型	示例值	描述
Image	String	`tos-cn-i-5sq****fo/2e39b35b98524100ae12b2ae07283cb2`	原图图片的 URL 或存储 URI。
Template	String	`tplv-5sq****fo-38.png`	转码模板

ExecOutput

参数	类型	示例值	描述
Size	Long	`9800`	转码结果图大小，单位为 byte。
Format	String	`png`	转码结果图格式
Output	String	`tos-cn-i-5sq***fo/_offtrans__1248x1053_f8_b*f_png`	转码结果图的存储 URI。仅当`Status`值为`Success`时，`Output`有值。
ErrCode	String	`615011`	转码失败错误码。仅当`Status`值为`Fail`时，`ErrCode`有值。
ErrMsg	String	`解码图片要素失败`	转码失败错误信息。仅当`Status`值为`Fail`时，`ErrMsg`有值。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageTranscodeDetails&Version=2023-05-01&QueueId=649a9dbc32**064d44cf5b0&Region=&StartTime=1684713599&EndTime=1685913599&Status=Pending&SearchPtn=tos-cn-i-5sq****fo/test&Limit=10&Offset=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230628142619F2291EF9CDE424237D15",
        "Action": "GetImageTranscodeDetails",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ExecInfo": [
            {
                "EntryId": "649a9332***80e9cc0a0ef",
                "SubmitAt": "2023-06-27 15:43:46",
                "StartAt": "2023-06-27 15:44:11",
                "EndAt": "2023-06-27 15:44:13",
                "Status": "Success",
                "ExecInput": {
                    "Image": "tos-cn-i-5sq****fo/f194ac4b7e22dc92fba0ff3aa4638b3c",
                    "Template": "tplv-5sq****fo-38.png"
                },
                "ExecOutput": {
                    "Size": 410400,
                    "Format": "png",
                    "Output": "tos-cn-i-5sq****fo/_offtrans__1248x1053_fe7b9183347e58c1ada53466d83165b8_bf6b6c5c8be8a0853417566b7938648fca9550181691d1f3775aa1f2cfc3d3bf_png",
                    "ErrCode": "0",
                    "ErrMsg": ""
                }
            },
            {
                "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": {
                    "Image": "tos-cn-i-5sq****fo/2e39b35b98524100ae12b2ae07283cb2",
                    "Template": "tplv-5sq****fo-38.png"
                },
                "ExecOutput": {
                    "Size": 0,
                    "Format": "",
                    "Output": "",
                    "ErrCode": "615011",
                    "ErrMsg": "解码图片要素失败"
                }
            }
        ],
        "Total": 2
    }
}

错误码

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

服务端 SDK

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

历史版本

2018-08-01 版本 GetImageTranscodeDetails 接口文档现已停止维护，建议您参考本文档使用最新版本。