数据万象
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据万象 > API 文档 > 文件处理 > 压缩包预览

压缩包预览

最近更新时间：2024-04-16 11:53:52

我的收藏

本页目录：

功能描述

该接口可以在不解压文件的情况下预览压缩包内的内容，包含文件数量、名称、文件时间等，接口为同步请求方式。

授权说明

授权策略中 action 设置为 ci:CreateFileProcessJobs 。详情请参见 数据万象 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通文件处理服务 。详情请参见 开通文件处理服务。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。
不支持处理 COS 上的归档存储类型和深度归档存储类型的文件，如果需要处理此类型文件，请先 恢复归档文件。
支持预览的压缩包格式：zip、tar、gz、7zip、rar。
预览压缩包大小限制：zip/7zip无大小限制，tar/gz/rar需小于128MB。
预览压缩包内的文件数限制：仅支持预览内部文件数量小于1000的压缩包。
请求超时时间：10秒。
调用接口需携带签名，具体规则请参见 请求签名 文档。
本接口当前支持以下地域：北京、上海、广州、成都、南京、重庆、中国香港、新加坡、硅谷。

费用说明

调用接口会产生 文件解压费用。
如果文件为 COS 上的低频存储类型，调用会产生 COS 低频数据取回费用。

请求

请求示例

GET /for-test.zip?ci-process=zippreview&zipfile-url=<url>&uncompress-key=<key> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
说明
Authorization: Auth String（详情请参见 请求签名 文档）。
通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。
该请求为 cos 域名。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求参数

参数说明如下：
节点名称（关键字）
描述
是否必选
ci-process
操作类型，压缩包预览计算固定为：zippreview。
是
zipfile-url
该字段用于预览非 COS 上的压缩包，需填写完整的文件链接，文件链接需进行 URLEncode。
否
uncompress-key
对于已加密的压缩包，可通过该字段填入解密密钥，密钥需进行 base64编码。
否

请求体

该请求无请求体。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <FileNumber>2</FileNumber>
    <Contents>
        <Key>test1.jpg</Key>
        <LastModified>2021-11-21T12:30:42+0000</LastModified>
        <UncompressedSize>46743</UncompressedSize>
    </Contents>
    <Contents>
        <Key>test2.mp3</Key>
        <LastModified>2021-11-22T12:11:26+0000</LastModified>
        <UncompressedSize>733318</UncompressedSize>
    </Contents>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
FileNumber
Response
压缩包中的文件数量
Int
Contents
Response
保存文件信息的容器
Container 数组
Container 节点 Contents 的内容：
节点名称（关键字）
父节点
描述
类型
Key
Response.Contents
文件名称
String
LastModified
Response.Contents
文件的最近一次修改的时间
String
UncompressedSize
Response.Contents
文件压缩前的大小
Int

错误码

该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

GET /for-test.zip?ci-process=zippreview HTTP/1.1
Host: test-1234567890.cos.ap-beijing.myqcloud.com
Authorization: q-sign-algorithm=sha1&q-ak=AKIDWtTCBYjM5OwLB9CAwA1Qb2ThTSUjfG****-sign-time=1484213027;32557109027&q-key-time=1484213027;32557109027&q-header-list=host&q-url-param-list=acl&q-signature=dcc1eb2022b79cb2a780bf062d3a40e120b4****
Content-Length: 0

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-cos
x-cos-request-id: NTg3NzRiMjVfYmRjMzVfMTViMl82ZGZmNw==

<Response>
    <FileNumber>2</FileNumber>
    <Contents>
        <Key>test1.jpg</Key>
        <LastModified>2021-11-21T12:30:42+0000</LastModified>
        <UncompressedSize>46743</UncompressedSize>
    </Contents>
    <Contents>
        <Key>test2.mp3</Key>
        <LastModified>2021-11-22T12:11:26+0000</LastModified>
        <UncompressedSize>733318</UncompressedSize>
    </Contents>
</Response>

中国站