文档中心

删除任务队列

最近更新时间：2024.01.31 14:30:24

首次发布时间：2023.12.25 16:48:05

该接口支持通过指定待删除的任务队列 ID 在账号内删除该任务队列。

注意

每个账号内置的一个默认任务队列不允许被删除。

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
QueueId	String	是	`649a9dbc32**64d44cf5b0`	待删除的队列 ID，您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。账号内置默认任务队列不允许被删除。

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageTranscodeQueue&Version=2023-05-01
{
  "QueueId": "649a9dbc32**064d44cf5b0"
}

返回示例

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

错误码

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

服务端 SDK

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