获取批量处理任务队列--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取批量处理任务队列

最近更新时间：2025.11.06 16:14:05首次发布时间：2025.07.28 16:12:37

调用 GetImageAIProcessQueues 接口，获取当前账号下已创建的批量处理任务队列详情。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAIProcessQueues`	接口名称。当前 API 的名称为 `GetImageAIProcessQueues`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
SearchPtn	String	否	`test`	返回队列名称或队列描述中包含该值的队列。默认返回所有队列。
Limit	Integer	是	`10`	分页条数，取值范围为 (0, 100]。
Offset	Integer	否	`0`	分页偏移量，默认为 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。

返回参数

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

参数	类型	示例值	描述
Queues	Array of Queues	`-`	当前分页队列详细信息。
Total	Integer	`1`	符合条件的队列总数。

Queues

参数	类型	示例值	描述
Id	String	`62f224ce61****826e38c29a`	任务队列 ID。
Name	String	`test`	任务队列名称。
Desc	String	`ceshi`	任务队列描述。
Status	String	`Pending`	任务队列状态。取值如下： `Pending`：排队中 `Running`：执行中
Type	String	`ai`	任务队列类型。取值如下： `default`：表示账号默认队列，每个账号一个 `user`：表示用户创建队列，个数将有配额限制
CreateAt	String	`2025-07-02 15:04:05`	任务队列的创建时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
Attribute	String	`bgfill`	任务队列属性。取值如下： `ai_super_resolution`：AIGC 大模型超分辨率 `bgfill`：智能图像扩展 `super_resolution`：图像超分辨率（云端） `InfiniteCreations`：电商万创 `image_translate`：AIGC 图片翻译 `image_quality_evaluate`：大模型画质评估
EnableCallback	Boolean	`true`	任务队列是否开启回调配置，取值如下： `true`：开启 `false`：不开启
CallbackConf	Object of CallbackConf	`-`	任务队列回调设置。

CallbackConf

参数	类型	示例值	描述
Method	String	`HTTP`	回调方式。仅支持取值 `HTTP`。
Endpoint	String	`https://demo.com`	回调 HTTP 请求地址，用于接收批量处理结果详情。支持使用 https 和 http 协议。
DataFormat	String	`JSON`	回调数据格式。取值如下： `XML` `JSON`
Args	String	`product id`	业务自定义回调参数，将在回调消息的`callback_args`中透传出去。具体回调参数请参考回调内容。
Type	String	`task`	回调触发类型。取值如下： `task`：整个任务处理完成后触发回调。单次回调最多包含 5000 张图片的处理信息，若超过该上限，veImageX 将分多次发送回调消息。 `entry`：单个条目处理完成后触发回调。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAIProcessQueues&Version=2023-05-01&SearchPtn=test&Limit=10&Offset=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageAIProcessQueues",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Queues": [
            {
                "Id": "62f224ce61****826e38c29a",
                "Name": "test",
                "Desc": "ceshi",
                "Status": "Pending",
                "Type": "ai",
                "CreateAt": "2025-07-02 15:04:05",
                "Attribute": "bgfill",
                "EnableCallback": true,
                "CallbackConf": {
                    "Method": "HTTP",
                    "Endpoint": "https://demo.com",
                    "DataFormat": "JSON",
                    "Args": "product id",
                    "Type": "task"
                }
            }
        ]
    }
}

错误码

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