更新批量处理任务队列状态--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新批量处理任务队列状态

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

调用 UpdateImageAIProcessQueueStatus 接口，更新指定批量处理任务队列的状态。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageAIProcessQueueStatus`	接口名称。当前 API 的名称为 `UpdateImageAIProcessQueueStatus`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数类型是否必选示例值描述

Id String 是 62f224ce61****826e38c29a 任务队列 ID。您可调用 GetImageAIProcessQueues 接口，通过返回参数 Id 获取队列 ID。

参数	类型	是否必选	示例值	描述
Id	String	是	`62f224ce61****826e38c29a`	任务队列 ID。您可调用 GetImageAIProcessQueues 接口，通过返回参数 `Id` 获取队列 ID。
Status	String	是	`Pending`	任务队列状态。取值如下： `Pending`：排队中 `Running`：执行中

Status

String

是

Pending

任务队列状态。取值如下：

Pending：排队中
Running：执行中

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageAIProcessQueueStatus&Version=2023-05-01
{
    "Id": "62f224ce61****826e38c29a",
    "Status": "Pending"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageAIProcessQueueStatus",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

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