更新任务队列状态--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新任务队列状态

最近更新时间：2024.08.14 11:29:16首次发布时间：2023.12.25 16:48:05

该接口支持通过指定待更新的任务队列 ID 来更新该队列的状态。

注意事项

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

请求说明

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

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

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

Body

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

Id String 是 649a9dbc32**64d44cf5b0 待更新的队列 ID，您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。

参数	类型	是否必选	示例值	描述
Id	String	是	`649a9dbc32**64d44cf5b0`	待更新的队列 ID，您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。
Status	String	是	`Pnding`	更新后的队列状态。取值如下所示： `Pending`：排队中 `Running`：执行中

Status

String

是

Pnding

更新后的队列状态。取值如下所示：

Pending：排队中
Running：执行中

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageTranscodeQueueStatus&Version=2023-05-01
{
  "Id": "649a9dbc32**64d44cf5b0",
  "Status": "Pnding"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageTranscodeQueueStatus",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 UpdateImageTranscodeQueueStatus 接口文档现已停止维护，建议您参考本文档使用最新版本。