You need to enable JavaScript to run this app.
导航
获取任务执行详情
最近更新时间:2024.08.05 18:26:10首次发布时间:2023.06.28 17:49:11

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

说明

  • 仅支持保存并查询任务结束时间在近 7 天的处理任务。
  • 该接口属于历史版本 API,建议您使用新版GetImageTranscodeDetails接口。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒

  • 超时时间:超时时间为 10 秒

请求说明

  • 请求方式:GET

  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageTranscodeDetails&Version=2018-08-01

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选示例值描述
ActionStringGetImageTranscodeDetails接口名称。GetImageTranscodeDetails
VersionString2018-08-01接口版本
QueueIdString649a9dbc32**064d44cf5b0队列 ID,您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。

StartTime

Integer

1684713599

任务提交的起始 Unix 时间戳
StartTimeEndTime时间间隔最大不超过 7 天。

EndTime

Integer

1685913599

任务提交的截止 Unix 时间戳
StartTimeEndTime时间间隔最大不超过 7 天。

Status

String

Pending

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

  • Pending:排队中
  • Running:执行中
  • Success:执行成功
  • Fail:执行失败
SearchPtnStringtos-cn-i-5sq****fo/test返回图片 url 或 uri 中包含该值的任务。默认为空,不传则返回所有任务。
LimitInteger10分页条数,取值范围为(0, 100]。
OffsetInteger0分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。

返回参数

参数类型示例值描述
ExecInfoArray of ExecInfo执行任务详情
TotalInteger5总数

ExecInfo

参数类型示例值描述
EntryIdString64993499**0df83eb707812执行条目 ID
SubmitAtString2023-06-27 15:43:46提交时间
StartAtString2023-06-27 15:44:11开始时间
EndAtString2023-06-27 15:44:13结束时间

Status

String

Success

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

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

ExecInput

参数类型示例值描述
ImageStringtos-cn-i-5sq****fo/f194ac4b7e22dc92fba0ff3aa4638b3c图片 url 或 uri
TemplateStringtplv-5sq****fo-38.png转码模板

ExecOutput

参数类型示例值描述
SizeInteger410400转码结果图大小,单位为 byte
FormatStringpng转码结果图格式
OutputStringtos-cn-i-5sq****fo/_offtrans__1248x1053_f*8_b*f_png转码结果图的存储 URI。仅当Status值为Success时,Output有值。
ErrCodeString615011转码失败错误码。仅当Status值为Fail时,ErrCode有值。
ErrMsgString解码图片要素失败转码失败错误信息。仅当Status值为Fail时,ErrMsg有值。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageTranscodeDetails&Version=2018-08-01&QueueId=64993499**0df83eb707812&StartTime=1687276800&EndTime=1687967999&Offset=0&Limit=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230628142619F2291EF9CDE424237D15",
        "Action": "GetImageTranscodeDetails",
        "Version": "2018-08-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
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。