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

对象存储

复制全文
下载 pdf
文件解压缩
GetFileUncompress
复制全文
下载 pdf
GetFileUncompress
功能描述​
此接口用于查询文件解压任务。​
注意事项​
  • 此接口当前处于邀测状态,如需使用,请联系客户经理开通白名单。​
  • 使用子账号操作时,请先通过主账号或拥有访问控制管理权限的子账号在访问控制 > 权限策略中创建或编辑自定义策略,为当前桶添加 tos:GetDataProcessJob 权限,再将该策略绑定至需要使用本功能的子账号。​
请求消息样式​
​
GET /?job_type=FileUncompress&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​
是​
FileUnCompress​
任务类型,取值 FileUncompress,表示文件解压任务。​
job_id​
String​
是​
8c6c1aa3a3d5948b27f000181fb*******​
提交任务时返回的 JobId,可通过CreateFileUncompress 获取。​
  • 不传时查询任务列表。​
  • 传入时查询单个任务。​
​
请求元素​
该请求使用的公共请求消息头,请参见公共参数。​
​
名称​
参数类型​
是否必填​
示例值​
说明​
start_time​
Int64​
否​
1753660800​
任务开始执行时间,Unix 时间戳(秒)。不传或 <= 0 时表示不限制。​
end_time​
Int64​
否​
1753747200​
任务结束时间,Unix 时间戳(秒)。不传或 <= 0 时表示不限制。​
page_size​
Int32​
否​
20​
单页任务数量。不传或 <= 0 时使用服务端默认值,默认值以您的 DP 服务端配置为准。。​
page_token​
String​
否​
-​
分页标记。​
第一次请求时首页传空。客户端后续请求时,将上一次响应的 NextPageToken 作为 page_token 传入,获取下一页。​
​
响应消息头​
该请求返回公共响应消息头,请参见公共参数。​
响应元素​
​
名称​
参数类型​
示例值​
说明​
Items​
Array​
-​
本页任务列表。​
JobID​
String​
8c6c1aa3a3d5948b27f000181fb*******​
任务 ID。​
State​
String​
Success​
任务状态,取值如下:​
  • Submitted:已提交。​
  • Running:执行中。​
  • Success:成功。​
  • Failed:失败。​
  • Paused:暂停。​
  • Canceled:已取消。​
CreateTime​
String​
2026-07-28T11:00:00+08:00​
任务创建时间,格式为 RFC3339 。​
StartTime​
String​
2026-07-28T11:00:03+08:00​
任务开始执行时间,格式为 RFC3339 。​
未开始时取值为空。​
EndTime​
String​
2026-07-28T11:01:20+08:00​
任务结束时间(成功 / 失败 / 取消均会写入),格式为 RFC3339 。未结束时取值为空。​
NextPageToken​
String​
eyJvZmZzZXQiOjIw​
下一页标记,为空时表示任务已到末页。​
Code​
Int32​
0​
错误码,成功时取值为 0。​
Error​
String​
-​
错误摘要,成功时取值为空。​
Message​
String​
-​
错误详细描述,成功时取值为空。​
Input​
Object​
-​
待解压的压缩包信息。​
Object​
​
input/data.zst​
压缩包的名称。​
FileUncompressConfig​
Object​
-​
解压规则。​
Prefix​
​
output/​
指定解压后输出文件的前缀,不填则默认保存在存储桶根路径。​
父节点:FileUncompressConfig​
Output​
Object​
​
用于存放解压后的文件。​
FileUncompressResult​
Object​
-​
解压任务结果,任务未结束时字段为空。​
Region​
String​
cn-beijing​
解压后文件所在地域。​
父节点:FileUncompressResult​
Bucket​
String​
testbkt​
解压后文件所在存储桶。​
父节点:FileUncompressResult​
FileCount​
Int64​
1​
成功解压的文件数。​
zstd 场景下成功时恒为 1。解压状态以 State 参数返回。因部分损坏中止时,为已落盘的实际文件数。​
  • zstd 场景下即使有文件落盘,数据也为破损数据。​
  • zip 场景下落盘文件均为正常数据,即实际解压出的对象数。​
父节点:FileUncompressResult​
FileList​
Array​
output/data​
解压文件列表信息。​
父节点:FileUncompressResult​
Contents​
String​
-​
已成功解压的对象列表。​
IsTruncated​
Boolean​
false​
返回的对象列表是否被截断。取值如下:​
  • false:已返回全部结果。​
  • true:还有结果未返回。​
父节点:FileUncompressResult​
​
请求示例​
查询单个任务​
​
GET /?job_type=FileUncompress&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>​
​
查询任务列表​
​
GET /?job_type=FileUncompress&start_time=1753660800&end_time=1753747200&page_size=20&page_token= HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +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-28T11:00:00+08:00",​
"StartTime": "2026-07-28T11:00:03+08:00",​
"EndTime": "2026-07-28T11:01:20+08:00",​
"Code": 0,​
"Error": "",​
"Message": "",​
"Input": {​
"Object": "input/data.zst"​
},​
"FileUncompressConfig": {​
"Prefix": "output/"​
},​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "testbkt"​
},​
"FileUncompressResult": {​
"Region": "cn-beijing",​
"Bucket": "testbkt",​
"FileCount": 1,​
"FileList": {​
"Contents": [ "output/data" ],​
"IsTruncated": false​
}​
}​
}​
​
查询任务列表​
​
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": "FileUncompress",​
"Items": [​
{​
"JobID": "FileUncompress-xyz789",​
"State": "Success",​
"CreateTime": "2026-07-28T11:00:00+08:00",​
"StartTime": "2026-07-28T11:00:03+08:00",​
"EndTime": "2026-07-28T11:01:20+08:00",​
"Code": 0, "Error": "", "Message": "",​
"Input": { "Object": "input/data.zst" },​
"FileUncompressConfig": { "Prefix": "output/" },​
"Output": { "Region": "cn-beijing", "Bucket": "testbkt" },​
"FileUncompressResult": {​
"Region": "cn-beijing", "Bucket": "testbkt",​
"FileCount": 1,​
"FileList": { "Contents": [ "output/data" ], "IsTruncated": false }​
}​
},​
{​
"JobID": "FileUncompress-uvw456",​
"State": "Failed",​
"CreateTime": "2026-07-28T11:10:00+08:00",​
"StartTime": "2026-07-28T11:10:05+08:00",​
"EndTime": "2026-07-28T11:10:15+08:00",​
"Code": 400,​
"Error": "InvalidZstdStream",​
"Message": "zstd stream is corrupted at offset 12345",​
"Input": { "Object": "input/broken.zst" },​
"FileUncompressConfig": { "Prefix": "output/" },​
"Output": { "Region": "cn-beijing", "Bucket": "testbkt" },​
"FileUncompressResult": {​
"Region": "cn-beijing", "Bucket": "testbkt",​
"FileCount": 0,​
"FileList": { "Contents": [], "IsTruncated": false }​
}​
}​
],​
"NextPageToken": ""​
}​
​
​
最近更新时间:2026.09.17 17:58:53
这个页面对您有帮助吗?
有用
有用
无用
无用