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

对象存储

复制全文
下载 pdf
文件解压缩
GetFileCompress
复制全文
下载 pdf
GetFileCompress
功能描述​
此接口用于查询多文件打包压缩任务。支持按 JobId 查询单个任务和按时间范围分页列举任务两种模式。​
注意事项​
  • 此接口当前处于邀测状态,如需使用,请联系客户经理开通白名单。​
  • 使用子账号操作时,请先通过主账号或拥有访问控制管理权限的子账号在访问控制 > 权限策略中创建或编辑自定义策略,为当前桶添加 tos:GetDataProcessJob 权限,再将该策略绑定至需要使用本功能的子账号。​
请求消息样式​
​
GET /?job_type=FileCompress&job_id=8c6c1aa3a3d5948b27f000181fb******* HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
​
请求参数和消息头​
​
名称​
参数类型​
是否必填​
示例值​
说明​
job_type​
String​
是​
FileCompress​
任务类型,取值为 FileCompress,表示多文件打包压缩任务。​
job_id​
String​
是​
8c6c1aa3a3d5948b27f000181fb*******​
提交任务时返回的 JobId,可通过 CreateFileCompress 获取。​
  • 不传时查询任务列表。​
  • 传入时查询单个任务。​
​
请求元素​
该请求使用的公共请求消息头,请参见公共参数。​
​
名称​
参数类型​
是否必填​
示例值​
说明​
start_time​
Int64​
否​
1753660800​
任务开始执行时间,Unix 时间戳(秒)。不传或 <= 0 表示不限。​
end_time​
Int64​
否​
1753747200​
任务结束时间,Unix 时间戳(秒)。不传或 <= 0 表示不限。​
page_size​
Int32​
否​
20​
单页任务数量。不传或 <= 0 时使用服务端默认值,默认值以您的 DP 服务端配置为准。​
page_token​
String​
否​
-​
分页标记,取上一页响应中的 NextPageToken,首页传空。​
​
响应消息头​
该请求返回公共响应消息头,请参见公共参数。​
响应元素​
​
名称​
参数类型​
示例值​
说明​
Items​
Array​
-​
本页任务列表。​
JobID​
String​
FileCompression-******​
任务 ID。​
State​
String​
Success​
任务状态,取值如下:​
  • Submitted:已提交。​
  • Running:执行中。​
  • Success:成功。​
  • Failed:失败。​
  • Paused:暂停。​
  • Canceled:已取消。​
CreateTime​
String​
2026-07-28T10:00:00+08:00​
任务创建时间,格式为 RFC3339 。​
StartTime​
String​
2026-07-28T10:00:05+08:00​
任务开始执行时间,格式为 RFC3339 ,未开始时为空。​
EndTime​
String​
2026-07-28T10:02:30+08:00​
任务结束时间(成功 / 失败 / 取消均会写入),格式为 RFC3339 ,未结束时为空。​
NextPageToken​
String​
eyJvZmZzZXQiOjIw​
下一页标记,为空表示已到末页。​
Code​
Int32​
0​
错误码,成功时为 0,失败时为 HTTP 状态码。​
Error​
String​
-​
错误摘要,成功时为空,失败时为错误码。​
Message​
String​
-​
错误详细描述,成功时为空,失败时为错误原因。​
Input​
Object​
-​
返回压缩的源文件信息。​
KeyConfig​
Array ​
-​
压缩的文件列表。​
父节点:Input​
Key​
String​
input/data.bin​
压缩的文件。​
父节点:KeyConfig​
FileCompressConfig​
Object​
-​
压缩规则。​
Format​
​
zst​
压缩格式,取值如下:​
  • zip​
  • zst​
父节点:FileCompressConfig​
Output​
Object​
-​
压缩包的存放位置。​
FileCompressResult​
Object​
-​
压缩任务结果,任务未结束时字段为空。​
Region​
String​
cn-beijing​
压缩后文件所在地域。​
父节点:FileCompressResult​
Bucket​
String​
testbkt​
压缩后文件所在存储桶。​
父节点:FileCompressResult​
Object​
String​
output/data.zst​
压缩后文件的完整对象名。​
父节点:FileCompressResult​
CompressFileCount​
Int64​
1​
成功写入压缩包的源文件数。zstd 场景取值固定为 1。​
父节点:FileCompressResult​
ErrorCount​
Int64​
0​
压缩失败的源文件数。zstd 场景失败时为 1,且整个任务 State=Failed。​
父节点:FileCompressResult​
ErrorDetail​
Array​
-​
压缩失败的源对象列表。​
父节点:FileCompressResult​
ErrorFile​
String​
-​
压缩失败的源对象。​
父节点:ErrorDetail​
​
请求示例​
查询单个任务​
​
GET /?job_type=FileCompress&job_id=8c6c1aa3a3d5948b27f000181fb******* HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Tue, 28 Jul 2026 02:00:00 +0000​
Authorization: <authorization_string>​
​
查询任务列表​
​
GET /?job_type=FileCompress&start_time=1753660800&end_time=1753747200&page_size=20&page_token= HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Tue, 28 Jul 2026 02:00:00 +0000​
Authorization: <authorization_string>​
​
响应示例​
查询单个任务​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
Content-Type: application/json​
​
{​
"JobID": "8c6c1aa3a3d5948b27f000181fb*******",​
"State": "Success",​
"CreateTime": "2026-07-28T10:00:00+08:00",​
"StartTime": "2026-07-28T10:00:05+08:00",​
"EndTime": "2026-07-28T10:02:30+08:00",​
"Code": 0,​
"Error": "",​
"Message": "",​
"Input": {​
"KeyConfig": [ { "Key": "input/data.bin" } ]​
},​
"FileCompressConfig": {​
"Format": "zst"​
},​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "testbkt",​
"Object": "output/data.zst"​
},​
"FileCompressResult": {​
"Region": "cn-beijing",​
"Bucket": "testbkt",​
"Object": "output/data.zst",​
"CompressFileCount": 1,​
"ErrorCount": 0,​
"ErrorDetail": { "ErrorFile": [] }​
}​
}​
​
查询任务列表​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
Content-Type: application/json​
​
{​
"JobType": "FileCompress",​
"Items": [​
{​
"JobID": "FileCompression-abc123",​
"State": "Success",​
"CreateTime": "2026-07-28T10:00:00+08:00",​
"StartTime": "2026-07-28T10:00:05+08:00",​
"EndTime": "2026-07-28T10:02:30+08:00",​
"Code": 0, "Error": "", "Message": "",​
"Input": { "KeyConfig": [ { "Key": "input/data.bin" } ] },​
"FileCompressConfig": { "Format": "zst" },​
"Output": { "Region": "cn-beijing", "Bucket": "testbkt", "Object": "output/data.zst" },​
"FileCompressResult": {​
"Region": "cn-beijing", "Bucket": "testbkt", "Object": "output/data.zst",​
"CompressFileCount": 1, "ErrorCount": 0,​
"ErrorDetail": { "ErrorFile": [] }​
}​
},​
{​
"JobID": "FileCompression-def456",​
"State": "Running",​
"CreateTime": "2026-07-28T10:05:00+08:00",​
"StartTime": "2026-07-28T10:05:02+08:00",​
"EndTime": "",​
"Code": 0, "Error": "", "Message": "",​
"Input": { "KeyConfig": [ { "Key": "input/other.bin" } ] },​
"FileCompressConfig": { "Format": "zst" },​
"Output": { "Region": "cn-beijing", "Bucket": "testbkt", "Object": "output/other.zst" },​
"FileCompressResult": {}​
}​
],​
"NextPageToken": "eyJvZmZzZXQiOjIw"​
}​
​
​
最近更新时间:2026.09.17 17:58:33
这个页面对您有帮助吗?
有用
有用
无用
无用