创建多文件压缩异步任务

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

• 方式 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

请求参数

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

Query

Body

FileList

返回参数

示例

请求示例

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，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：

• Golang SDK
• Java SDK
• Python SDK

回调内容

回调示例如下所示。

{
	"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"
	}
}