You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
文件解压缩
CreateFileCompress
复制全文
下载 pdf
CreateFileCompress
功能描述​
此接口用于提交多文件打包压缩任务,压缩单个或多个文件,压缩完成后,异步返回压缩包。​
注意事项​
​
限制类型​
限制说明​
邀测限制​
此接口当前处于邀测状态,如需使用,请联系客户经理开通白名单。​
权限要求​
使用子账号操作时,请先通过主账号或拥有访问控制管理权限的子账号在访问控制 > 权限策略中创建或编辑自定义策略,为当前桶添加 tos:CreateFileProcessJobs 权限,再将该策略绑定至需要使用本功能的子账号。​
格式限制​
zstd 为单流压缩格式,不支持通过 Input.Prefix 进行目录前缀打包。​
路径规则​
  • 压缩后文件不保留源文件的路径和文件名。​
  • 不提供目录扁平化控制参数。​
大小限制​
压缩前单个文件大小上限为 40 GB。​
文件数量限制​
zstd 场景下数量限制为 1 个。​
加密限制​
不支持加密压缩包。​
​
请求消息样式​
​
POST /?file_jobs&job_type=FileCompress HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization_string​
Content-Type: application/json​
​
{​
"Input" : {​
"KeyConfig" : [{"Key":"input/obj1"},{"Key":"input/obj2"}] ​
},​
"FileCompressConfig" : {​
"Format" : "zip",​
"Flatten" : 0​
},​
"Output" : {​
"Region" : "cn-beijing",​
"Bucket" : "testbkt",​
"Object" : "output/test.zip"​
}​
}​
​
请求参数和消息头​
该请求使用的公共请求消息头,请参见公共参数。​
​
名称​
位置​
参数类型​
是否必选​
示例值​
说明​
file_jobs​
Query​
String​
是​
-​
代表 FileCompress 请求的特殊标识。​
job_type​
Query​
String​
是​
FileCompress​
任务类型,取值为 FileCompress,表示多文件打包压缩任务。​
​
请求元素​
​
名称​
参数类型​
是否必选​
示例值​
说明​
Input​
Array​
是​
-​
设置压缩的源文件信息。​
Prefix​
String​
否​
-​
  • 指定压缩的文件前缀,如果需要对某个目录进行打包,则需要添加 /。例如压缩 test 文件夹,则需要设置 Prefix 为 test/。​
  • 仅Format取值为 zip 时生效。​
父节点:Input​
KeyConfig​
Array​
否​
​
-​
指定压缩的文件。最多可以指定 1000 个对象。​
父节点:Input​
Key​
String​
否​
input/obj1​
指定压缩的文件,需要填写为完整的文件名称。​
父节点:KeyConfig​
FileCompressConfig​
Array​
是​
-​
压缩规则。​
Format​
String​
是​
zst​
压缩格式,取值如下:​
  • zip​
  • zst​
父节点:FileCompressConfig​
Flatten​
​
Integer​
是​
​
0​
设置文件在压缩包中的目录结构,仅Format取值为 zip 时生效。取值说明如下:​
  • 0:不去除原有的目录结构,打包后压缩包中的文件会保留原有的目录结构。​
  • 1:去除原有的目录结构,打包后压缩包内的所有文件都放置在压缩包根目录下。​
  • 2:仅以 Prefix 方式打包文件时,才能设置 Flatten 为 2,表示不去除原有的目录结构,在打包时会先创建一个目录,Prefix 参数最后一层作为目录名称,目录内是当前打包的所有文件及文件夹。​
  • 3:仅以 Prefix 方式打包文件时,才能设置 Flatten 为 3,表示不去除原有的目录结构,打包时将Prefix 参数下的所有文件(不包含Prefix 参数)都放置在压缩包根目录下。​
例如以 Prefix 的方式打包文件,设置 Prefix 为 aaa/bbb/,aaa/bbb/ 文件夹包含 aaa/bbb/ccc/music.image 文件,不同的 Flatten 值,aaa/bbb/ccc/music.image 文件在压缩包内的保存路径如下:​
  • 0:aaa/bbb/ccc/music.image​
  • 1:music.image​
  • 2:bbb/ccc/music.image​
  • 3:ccc/music.image​
父节点:FileCompressConfig​
Output​
Array​
是​
-​
压缩包的存放位置。​
Region​
String​
是​
cn-beijing​
存放压缩包的存储桶地域,不支持跨地域存储。​
父节点:Output​
Bucket​
String​
是​
testbkt​
存放压缩包的存储桶名称。​
父节点:Output​
Object​
​
String​
是​
output/test.zip​
压缩包的名称。​
父节点:Output​
​
响应消息头​
该请求返回公共响应消息头,请参见公共参数。​
响应元素​
​
名称​
参数类型​
示例值​
说明​
Code​
String​
Success​
状态码。​
  • 请求成功时返回值为 Success。​
  • 请求失败时返回值为对应的错误码。​
JobId​
String​
18c6c14ef737d68cb27f000181fa********​
任务 ID。多文件打包压缩任务提交后,您可以在 Bucket 参数指定的存储桶中查看对应压缩包。​
​
请求示例​
​
POST /?file_jobs&job_type=FileCompress HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
Content-Type: application/json​
​
{​
"Input": {​
"KeyConfig": [ { "Key": "input/obj1" } ]​
},​
"FileCompressConfig": {​
"Format": "zst"​
},​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "testbkt",​
"Object": "output/test.zst"​
}​
}​
​
响应示例​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
​
{​
"Code": "Success",​
"Message": "",​
"JobId": "18c6c14ef737d68cb27f000181fa********"​
}​
​
最近更新时间:2026.09.17 17:58:02
这个页面对您有帮助吗?
有用
有用
无用
无用