获取离线转码任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取离线转码任务

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

本接口支持查询指定队列下提交的各个转码任务的详情。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageTranscodeTasks`	接口名称。当前 API 的名称为 `GetImageTranscodeTasks`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
QueueId	String	是	`63db57e36**cce1ffee11bb1`	队列 ID，您可通过调用 GetImageTranscodeQueues 获取该账号下全部队列 ID。
TaskId	String	否	`649b9d3****5537684010a7`	任务 ID，缺省时查询指定队列下全部的任务。
Status	String	否	`Failed`	指定查询的任务状态，缺省时将查询全部状态的任务。取值如下所示： `Running`：任务运行中 `Suspend`：任务中断 `Done`：任务已完成 `Cancel`：任务取消 `Failed`：任务失败
Region	String	是	`cn`	队列所在地区。默认取值为 `cn`，表示国内。
StartTime	Float	是	`1728921600`	查询的起始 Unix 时间戳，`StartTime`与`EndTime`时间间隔最大不超过 7 天。
EndTime	Float	是	`1729612799`	查询的结束 Unix 时间戳，`StartTime`与`EndTime`时间间隔最大不超过 7 天。
Limit	Float	否	`10`	单次查询列出的任务的个数，取值范围为 (0,1000]，默认值为 1000。
Marker	String	否	`0`	上一次查询返回的位置标记，作为本次查询的起点信息，默认值为空。

返回参数

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

参数	类型	示例值	描述
QueueId	String	`63db57e36**cce1ffee11bb1`	指定的队列 ID
TaskInfo	Array of TaskInfo	`-`	转码任务的各类信息
HasMore	Boolean	`false`	是否还有更多任务，取值如下所示： `true`：是，还有任务未列出 `false`：否，已列出所有任务
Marker	String	`hkaiohwn**1WIO092WO`	`HasMore` 取值 `true` 时，即本次查询还有未列举到的任务时。`Marker` 作为查询起始位置标记，您需要在下一次查询时传入该值。

TaskInfo

参数	类型	示例值	描述
TaskId	String	`649b9d3****5537684010a7`	转码任务的 ID
Status	String	`Failed`	任务的执行状态
Total	Float	`1`	任务中包含的条目数
Success	Float	`0`	任务中执行成功的条目数
Fail	Float	`1`	任务中执行失败的条目数
Retry	Float	`0`	任务中重试的条目数。说明当因系统内部原因导致的条目转码失败，系统将自动重试该条目，最大重试次数为 5。
StartAt	String	`2024-10-22 13:28:16`	任务的开始执行时间
EndAt	String	`2024-10-22 14:28:16`	任务的结束执行时间
SubmitAt	String	`2024-10-22 13:26:46`	任务的提交时间
Type	String	`UrlFile`	任务中提交的图片类型

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageTranscodeTasks&Version=2023-05-01&QueueId=63db57e36**cce1ffee11bb1&TaskId=649b9d3****5537684010a7&Status=Failed&Region=cn&StartTime=1728921600&EndTime=1729612799&Limit=10&Marker=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageTranscodeTasks",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "QueueId": "63db57e36**cce1ffee11bb1",
        "TaskInfo": [
            {
                "TaskId": "649b9d3****5537684010a7",
                "Status": "Failed",
                "Total": 1,
                "Success": 0,
                "Fail": 1,
                "Retry": 0,
                "StartAt": "2024-10-22 13:28:16",
                "EndAt": "2024-10-22 14:28:16",
                "SubmitAt": "2024-10-22 13:26:46",
                "Type": "UrlFile",
                "Id": ""
            }
        ],
        "HasMore": false,
        "Marker": ""
    }
}

错误码

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