文档中心

创建任务队列

最近更新时间：2023.06.28 19:16:15

首次发布时间：2023.06.28 10:57:18

本接口支持在该账号创建离线转码任务队列，并自定义队列配置，如队列名称、队列描述、回调配置等。

注意事项

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

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageTranscodeQueue`	接口名称。`CreateImageTranscodeQueue`
Version	String	是	`2018-08-01`	接口版本

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`offline`	自定义任务队列名称
Desc	String	否	`离线转码`	自定义任务队列描述，可用于备注该队列的用途。
IsStart	Boolean	是	`false`	是否启动队列，开始执行离线转码操作。取值如下所示： `true`：启动 `false`：不启动
Region	String	是	`cn`	队列区域，固定取值为 `cn`。
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`中透传出去。具体回调参数请参考回调内容。

返回参数

参数	类型	示例值	描述
QueueId	String	`649a9dbc32**064d44cf5b0`	队列 ID。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTranscodeQueue&Version=2018-08-01
{
  "Name": "offline",
  "Desc": "离线转码",
  "IsStart": false,
  "Region": "cn",
  "CallbackConf": {
    "Method": "HTTP",
    "Endpoint": "https://demo.com",
    "DataFormat": "JSON",
    "Args": "product id"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateImageTranscodeQueue",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
  	"QueueId": "649a9dbc32**064d44cf5b0"
  }
}

错误码

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