本接口支持您通过指定任务队列 ID 和查询时间段获取当前队列的转码任务详情。
说明
请求频率:单用户请求频率限制为 10 次/秒。
超时时间:超时时间为 10 秒。
请求方式:GET
请求地址:https://imagex.volcengineapi.com/?Action=GetImageTranscodeDetails&Version=2018-08-01
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetImageTranscodeDetails | 接口名称。GetImageTranscodeDetails |
Version | String | 是 | 2018-08-01 | 接口版本 |
QueueId | String | 是 | 649a9dbc32**064d44cf5b0 | 队列 ID,您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。 |
StartTime | Integer | 是 |
| 任务提交的起始 Unix 时间戳 |
EndTime | Integer | 是 |
| 任务提交的截止 Unix 时间戳 |
Status | String | 否 |
| 执行状态,填入多个时使用英文逗号分隔。取值如下所示:
|
SearchPtn | String | 否 | tos-cn-i-5sq****fo/test | 返回图片 url 或 uri 中包含该值的任务。默认为空,不传则返回所有任务。 |
Limit | Integer | 是 | 10 | 分页条数,取值范围为(0, 100]。 |
Offset | Integer | 否 | 0 | 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ExecInfo | Array of ExecInfo | 执行任务详情 | |
Total | Integer | 5 | 总数 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
EntryId | String | 64993499**0df83eb707812 | 执行条目 ID |
SubmitAt | String | 2023-06-27 15:43:46 | 提交时间 |
StartAt | String | 2023-06-27 15:44:11 | 开始时间 |
EndAt | String | 2023-06-27 15:44:13 | 结束时间 |
Status | String |
| 执行状态。取值如下所示:
|
ExecInput | Object of ExecInput | 执行输入 | |
ExecOutput | Object of ExecOutput | 执行输出 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Image | String | tos-cn-i-5sq****fo/f194ac4b7e22dc92fba0ff3aa4638b3c | 图片 url 或 uri |
Template | String | tplv-5sq****fo-38.png | 转码模板 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Size | Integer | 410400 | 转码结果图大小,单位为 byte |
Format | String | png | 转码结果图格式 |
Output | String | tos-cn-i-5sq****fo/_offtrans__1248x1053_f*8_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=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 } }