本接口支持向状态为运行中的任务队列,提交以一条或多条 URL/URI 资源转码执行任务组成的转码任务。
说明
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 请求头字段 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateImageTranscodeTask | 接口名称。当前 API 的名称为 CreateImageTranscodeTask 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
QueueId | String | 否 | 649a9dbc3***64d44cf5b0 | 任务队列名称 ID。缺省情况下提交至账号默认任务队列。您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。 |
ServiceId | String | 是 |
| 服务 ID。 |
Template | String | 是 | tplv-5s****fo-33.jpeg | 转码模板。您可通过调用 GetAllImageTemplates 获取指定服务下全部模版信息。 |
DataType | String | 是 |
| 数据类型,取值如下所示:
|
DataList | Array of String | 否 |
|
|
FileList | Array of String | 否 |
|
|
CallbackConf | Object of CallbackConf | 否 | - | 任务回调配置。缺省情况下默认使用队列回调配置。 |
ResKeyList | Array of String | 否 |
| 转码产物的 Storekey 列表,仅当
|
EnableExif | Boolean | 否 |
| 转码是否保留 exif。取值如下所示:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Method | String | 是 | HTTP | 回调方式。仅支持取值HTTP 。 |
Endpoint | String | 是 | https://demo.com | 回调 HTTP 请求地址,用于接收转码结果详情。支持使用 https 和 http 协议。 |
DataFormat | String | 否 |
| 回调数据格式。取值如下所示:
|
Args | String | 否 | product id | 业务自定义回调参数,将在回调消息的callback_args 中透传出去。具体回调参数请参考回调内容。 |
Type | String | 否 |
| 回调的维度类型,缺省情况下按照条目级别进行回调。取值如下所示:
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 错误码。
veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。
2018-08-01 版本 CreateImageTranscodeTask 接口文档现已停止维护,建议您参考本文档使用最新版本。