tencent cloud

Preview the Compressed Package
Download PDF
Last updated: 2025-11-19 11:45:26
Preview the Compressed Package
Last updated: 2025-11-19 11:45:26
Download PDF

Feature Description

This API can preview the contents of compressed packages without unzipping, including the number of files, names, and file times. The API uses synchronous request method.

Authorization Description

When used with a sub-account, the cos:GetObject permission must be granted. For details, please refer to COS action. For other CI permissions, please refer to Cloud Infinite action.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling file processing service in advance via console or API. For details, see Enable File Processing Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.
Does not support processing files with archive storage type and deep archive storage type on COS. If you need to process such files, please first restore archived files.
Compressed file formats that support preview: zip, tar, gz, 7zip, rar.
Preview compressed file size limits: No size limit for zip and 7zip formats; tar, gz, and rar formats must be less than 128MB.
File count limit for previewing compressed packages: Only supports previewing compressed packages with less than 1000 internal files.
request timeout: 10 seconds.
API calls require carrying a signature. For specific rules, please refer to the Request Signature document.
This interface currently supports the following regions: Beijing, Shanghai, Guangzhou, Chengdu, Nanjing, Chongqing, Hong Kong (China), Singapore, Silicon Valley.

Fee Description

API calls will incur file decompression costs.
If the file is of the low-frequency storage type on COS, the call will incur COS low-frequency data retrieval fees.

Request

Request sample:

GET /for-test.zip?ci-process=zippreview&uncompress-key=<key> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Description
Authorization: Auth String (For details, refer to Request Signature).
When used by a sub-account, relevant permissions must be granted. For details, see the Authorization Granularity Detail document.
This request is for a cos domain name.

Request header.

This API only uses common request headers. For details, see Common Request Headers documentation.

Request parameters.

The parameters are described as follows:
Node Name (Keyword)
Description
Required or Not
ci-process
operation type, compressed package preview calculation fixed as: zippreview.
Yes
uncompress-key
For encrypted compressed packages, you can fill in the decryption key in this field. The key needs to be base64 encoded.
No

Request body.

This request has no request body.

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<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>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
FileNumber
Response
Number of files in the compressed package
Int
Contents
Response
Container for saving file information
Container array
The content of Container node Contents
Node Name (Keyword)
Parent Node
Description
Type
Key
Response.Contents
File Name
String
LastModified
Response.Contents
Last modification time of the file
String
UncompressedSize
Response.Contents
Size before compression of the file
Int

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

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=*************************************&q-key-time=1484213027;32557109027&q-header-list=host&q-url-param-list=acl&q-signature=**************************************
Content-Length: 0

Response

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>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback