文档中心

创建多文件压缩异步任务

最近更新时间：2023.11.22 16:25:30

首次发布时间：2023.07.14 14:45:08

本接口支持通过指定压缩文件/文件夹及其他配置创建异步压缩任务，系统将执行压缩打包处理并将压缩包存储至指定服务内。支持以下两种压缩文件提交方式：

方式 1：FlieList 方式：需配置公网可访问的待压缩文件 URL 与 Alias，Folder 配置，不得超过 500。
方式 2：IndexFile 方式：在 .txt 文件（索引文件）内填写待压缩文件相关配置，每行需填写 StoreUri/URL,Alias,Folder相关配置，并将该索引文件上传至指定服务，并获取索引文件 StoreUri。
- 如果填写待压缩文件的 URL，则需满足公网可访问。您可下载 Compress_StoreUri.txt 参考示例，完成 URL 类型索引文件的填写。
  Compress_URL.txt
  110.00Bytes
- 如果填写带压缩文件的 StoreUri，则需存储至指定服务。您可下载 Compress_StoreUri.txt 参考示例，完成 StoreUri 类型索引文件的填写。
  Compress_StoreUri.txt
  100.00Bytes
说明
压缩文件类型不支持混用。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
文件大小：待压缩文件总大小不得超过 45000 MB。
前提条件：请在 veImageX 控制台提前开通多文件压缩组件。

请求说明

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

说明

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

请求参数

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

Query

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

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

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageCompressTask`	接口名称。当前 API 的名称为 `CreateImageCompressTask`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`7g**2i`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

7g**2i

服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
FileList	Array of FileList	否		与`IndexFile`，二选一。压缩文件列表配置，压缩文件 URL 最多为 500 个，总文件大小不超过 45000 MB。若超出限制，则取消压缩打包操作，直接返回错误。
IndexFile	String	否	`tos-boe-i-hr***pr/testcompress.txt`	与 `FileList`，二选一。索引文件 StoreUri，为 .txt 文件，该索引文件需上传至指定服务对应存储中。该索引文件内需填写待压缩文件的 StoreUri，每行填写一个，最多可填写 3000 行。总文件大小不超过 45000 MB。若超出限制，则取消压缩打包操作，直接返回错误。
Output	String	否	`testcompress`	压缩后文件压缩包的指定名称，默认为随机 Key。
ZipMode	Integer	是	`0`	压缩方法，取值如下所示： `0`：ZIP DEFLATE 压缩打包方法 `1`：仅保存文件，不执行压缩打包
Callback	String	否	`http://test.com`	POST 类型的回调 URL，用于接收相关回调 JSON 类型数据。回调参数请参考回调内容。

FileList

参数	类型	是否必选	示例值	描述
Url	String	是	`http://test.imagex.com/tos-cn-i-rw**qr/864c.png~tplv-rw*qr-6.image`	公网可访问的待压缩文件 URL
Alias	String	否	`compress1`	指定时，为 URL 文件所在压缩包中的别名。不指定时，若能提取原文件名称时，则以 URL 原文件名称；否则，使用随机名称。
Folder	String	否	`a/b`	URL 对应资源在压缩包中的文件夹，不传时则将该资源存储至一级目录下。不能以`/`结尾。

返回参数

参数	类型	示例值	描述
TaskId	String	`82370***12102`	压缩任务 ID

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageCompressTask&Version=2018-08-01&ServiceId=7g%2A%2A2i
{
   "FileList":[
      {
         "Url":"http://test.imagex.com/tos-cn-i-rw****qr/86****4c.png~tplv-rw***qr-6.image",
         "Alias":"compress1",
         "Folder":""
      },
      {
         "Url":"http://test.imagex.com/tos-cn-i-rw****qr/90****5j.png~tplv-rw***qr-1.image",
         "Alias":"compress2",
         "Folder":"a/b"
      }
   ],
   "Output":"compress_test",
   "ZipMode":0,
   "Callback":"http://test.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "CreateImageCompressTask",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
      "TaskId": "82370***12102"
  }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 Golang SDK来调用 API。

回调内容

参数名称	参数类型	参数描述
TaskId	String	异步压缩任务 ID
Status	String	任务状态，取值如下所示： `Failed`：压缩失败 `Success`：压缩成功
OutputUri	String	压缩包 StoreUri。
Err	String	错误信息。仅当`Status`为`Failed`时，该值不为空。
Code	Integer	错误码。仅当`Status`为`Failed`时，该值不为 0。
StartTime	int 64	创建开始时间，unix 时间，单位为纳秒。
EndTime	int 64	创建结束时间，unix 时间，单位为纳秒。
TimeCost	int 64	打包耗时时间，unix 时间，单位为毫秒。
ErrUrls	Array of String	打包失败的 URL/Uri 列表。

回调示例如下所示。

{
	"TaskId": "82370***12102",
	"Status": "Failed",
	"OutputUri": "tos-cn-i-hr***pr/testcompress.txt",
	"Err": "压缩失败",
	"Code": 604026,
	"StartTime": 1641027296000000000,
	"EndTime": 1641037921000000000,
	"TimeCost": 1200000,
	"ErrUrls": {
		"tos-cn-i-hr***pr/1.png",
		"tos-cn-i-hr***pr/test.jpg"
	}
}