创建批量处理异步任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建批量处理异步任务

最近更新时间：2024.04.19 11:54:49首次发布时间：2023.12.25 18:52:44

本接口用于创建批量处理异步任务，单次支持批量处理最多 5000 个资源。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 CreateBatchProcessTask 接口名称。当前 API 的名称为 CreateBatchProcessTask。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateBatchProcessTask`	接口名称。当前 API 的名称为 `CreateBatchProcessTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`9u**k2`	待执行异步批处理的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

9u**k2

待执行异步批处理的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
BatchingInfo	Array of BatchingInfo	是	`-`	指定服务下待批量处理的资源链接信息
Callback	String	否	`https://info.com`	回调地址，用于接收返回的回调信息。
CallbackBody	String	否	`{ "param1": "value1", "param2": "value2" }`	自定义回调内容，取值需要符合`CallbackBodyType`指定格式。
CallbackBodyType	String	否	`application/json`	回调内容格式。默认为空，若需指定`CallbackBody`时，也需同时指定`CallbackBodyType`的值。取值如下所示： `application/json` `application/x-www-form-urlencoded`

BatchingInfo

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Action	String	否	`meta`	批处理能力，取值如下所示： `meta`：获取资源元信息 `preload`：源站图片预热注意如需批量预热源站图片，请提交工单联系技术支持开启。
Url	String	否	`http://test.com/tos-cn-i-f0**5k/demo.png`	指定服务下待批处理资源的可访问 URL

Action

String

否

meta

批处理能力，取值如下所示：

meta：获取资源元信息
preload：源站图片预热

注意

如需批量预热源站图片，请提交工单联系技术支持开启。

Url String 否 http://test.com/tos-cn-i-f0**5k/demo.png 指定服务下待批处理资源的可访问 URL

返回参数

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

参数	类型	示例值	描述
TaskId	String	`92830H07WJS28370`	任务 ID

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateBatchProcessTask&Version=2023-05-01&ServiceId=9u**k2
{
    "BatchingInfo": [
        {
            "Action": "meta",
            "Url": "http://test.com/tos-cn-i-f0**5k/demo1.png"
        },
        {
            "Action": "meta",
            "Url": "http://test.com/tos-cn-i-f0**5k/demo.png"
        }
    ],
    "CallbackBodyType": "application/json",
    "CallbackBody": "{ 
	    "param1": "value1", 
	    "param2": "value2" 
    }",
    "Callback": "http://info.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateBatchProcessTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "92830H07WJS28370"
    }
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，已支持 Java SDK，帮助您更方便的调用 API。