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

文档中心

立即注册

导航

veImageX

更新任务队列状态

最近更新时间：2024.08.05 18:26:10首次发布时间：2023.06.28 10:58:13

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

说明

该接口属于历史版本 API，建议您使用新版UpdateImageTranscodeQueueStatus接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间为 5 秒。

请求说明

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

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageTranscodeQueueStatus`	接口名称。`UpdateImageTranscodeQueueStatus`
Version	String	是	`2018-08-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=2018-08-01
{
   "Id":"649a9dbc32**064d44cf5b0",
   "Status":"Pending"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageTranscodeQueueStatus",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。