tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationCloud Object Storage

Decompressing ZIP File via API

Focus Mode
Font Size
Last updated: 2025-11-13 18:12:02

Preparations

1. The ZIP decompression feature is implemented via the Serverless Cloud Function (SCF) service. Before use, you need to go to ZIP Decompression in the COS console to create a ZIP Decompression function. For more function creation instructions, see ZIP Decompression.
2. After creating the function, click Instructions on the right of the function to configure it. The configurations are a JSON string, which will be described in detail in this document.
If you select SCF authentication for the function, you need to call the Invoke API provided by SCF to run the ZIP decompression function, where the ClientContext parameter is passed in JSON format. For more information, see Function Parameter Configuration Sample.
If you configure the function to be authentication free, you can directly send HTTP requests to the corresponding API to call the function.

Function Parameter Configuration Example

Note:
In actual practice, delete the comments in the code.
{
    "bucket": "examplebucket-1250000000",    // Source bucket storing the ZIP package
    "region": "ap-guangzhou",         // Region where the bucket resides
    "key": "example.zip",              //  Name of the ZIP package
    "targetBucket": "examplebucket-1250000000",    // Target bucket to store the decompressed objects
    "region": "ap-guangzhou",         // Region where the target bucket resides
    "targetPrefix": "target/",              // Prefix of the directory to store the decompressed objects
}
The parameters are described as follows:
Parameter
Description
Type
Required
bucket
Source bucket storing the ZIP package, formatted as BucketName-APPID (e.g., examplebucket-1250000000)
String
Yes
region
Source bucket region. For the enumerated values, see Regions and Access Endpoints.
String
Yes
key
Name (object name) of the ZIP package. It is the unique ID of an object in a bucket. For more information, see Object Overview.
String
Yes
targetBucket
Target bucket to store the decompressed objects, formatted as BucketName-APPID (e.g., examplebucket-1250000000).
String
Yes
targetRegion
Target bucket region. For the enumerated values, see Regions and Access Endpoints.
String
Yes
targetPrefix
Prefix of the directory to store the decompressed objects. End a specified directory with / for saving to this directory, or keep it empty for saving to the root directory
String
No

Sample Response

{
    "code": 0,
    "message": "cos gunzip file success",
    "data": {
        "Bucket": "examplebucket-1250000000",
        "Region": "ap-guangzhou"
    }
}
Response parameters are described as follows:
Parameter
Description
Type
code
Business error code. 0: the execution is successful. Other values: execution failed.
Number
message
Text description of the execution result. The message may be null.
String
data
Information on successful execution. If the execution is successful, it contains information about the target bucket.
Object
error
Execution failure information. If the execution is successful, this parameter is null.
Object or String

Examples

Example 1. Decompress a file *.zip

Parameter configuration

{
  "bucket": "examplebucket-1250000000",
  "region": "ap-guangzhou",
  "key": "example.zip",
  "targetBucket": "examplebucket-1250000000",
  "targetRegion": "ap-guangzhou",
  "targetPrefix": "target/"
}

Location of the decompressed objects

target/example.txt

Next Topic: Release Notes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback