提交转码任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

提交转码任务

最近更新时间：2024.05.20 14:05:00首次发布时间：2023.12.25 16:48:06

本接口支持向状态为运行中的任务队列，提交以一条或多条 URL/URI 资源转码执行任务组成的转码任务。

说明

仅当队列为运行中时可向该队列提交任务，请您在控制台或调用 GetImageTranscodeQueues 接口查看任务队列状态是否为运行中。
一条任务队列（QueueId）可包含多个转码任务（TaskId），一个转码任务可由一条或多条 URL/URI 转码执行任务（EntryId）组成。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
QueueId	String	否	`649a9dbc3***64d44cf5b0`	任务队列名称 ID。缺省情况下提交至账号默认任务队列。您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。
ServiceId	String	是	`5s****fo`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Template	String	是	`tplv-5s****fo-33.jpeg`	转码模板。您可通过调用 GetAllImageTemplates 获取指定服务下全部模版信息。
DataType	String	是	`uri`	数据类型，取值如下所示： `uri`：指定 ServiceId 下存储 URI。 `url`：公网可访问的 URL。
DataList	Array of String	否	`["http://demo.com/example.png"]`	`DataList`和`Filelist`二选一必填，同时配置时，`DataList`优先生效。待转码的图片 uri 或 url 列表，最多支持 10 万条。若`DataType`取值`uri`，此处请传入指定 ServiceId 下的存储 URI。若`DataType`取值`url`，此处请传入公网可访问的 URL。
FileList	Array of String	否	`["tos-cn-i-5s*fo/a.txt","tos-cn-i-5s*fo/uridemo.txt"]`	`DataList`和`Filelist`二选一必填，同时配置时，`DataList`优先生效。待转码的图片 uri 或 url 文件列表。具体使用方式如下：在 txt、csv 文件内填写指定数据类型的待转码图片地址，每行填写一个，最多不超过 10 万条。将该文件上传至指定服务后，获取其存储 URI。将该存储 URI，传入 `FileList`。
CallbackConf	Object of CallbackConf	否	`-`	任务回调配置。缺省情况下默认使用队列回调配置。
ResKeyList	Array of String	否	`["name1","name2"]`	转码产物的 Storekey 列表，仅当`DataList`不为空时有效，长度需与`DataList`长度一致。不传时默认使用固定规则生成产物的 Storekey。填写规则如下：使用 UTF-8 编码。长度必须在 1～1024 个字符之间。不能以反斜线（\）开头。不支持 `\a`、`\b`、`\t`、`\n`、`\v`、`\f`、`\r` 字符。
EnableExif	Boolean	否	`false`	转码是否保留 exif。取值如下所示： `true`：保留 `false`：（默认）不保留

CallbackConf

参数	类型	是否必选	示例值	描述
Method	String	是	`HTTP`	回调方式。仅支持取值`HTTP`。
Endpoint	String	是	`https://demo.com`	回调 HTTP 请求地址，用于接收转码结果详情。支持使用 https 和 http 协议。
DataFormat	String	否	`JSON`	回调数据格式。取值如下所示： `XML` `JSON`（默认）
Args	String	否	`product id`	业务自定义回调参数，将在回调消息的`callback_args`中透传出去。具体回调参数请参考回调内容。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
TaskId	String	`649b9d3****5537684010a7`	任务 ID

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTranscodeTask&Version=2023-05-01
{
    "QueueId": "649a9dbc3***64d44cf5b0",
    "ServiceId": "5s****fo",
    "Template": "tplv-5s****fo-33.jpeg",
    "DataType": "uri",
    "DataList": [],
    "FileList": [
        "tos-cn-i-5s***fo/a.txt",
        "tos-cn-i-5s***fo/uridemo.txt"
    ],
    "ResKeyList": [
        "name1",
        "name2"
    ],
    "EnableExif": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageTranscodeTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "649b9d3****5537684010a7"
    }
}

错误码

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

服务端 SDK

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