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

Multi-File Zipping

PDF
Focus Mode
Font Size
Last updated: 2024-02-02 15:51:37

Overview

This document provides an overview of APIs and SDK code samples for file compression in CI.
API
Description
Submits a multi-file zipping job.
Queries the result of a specified multi-file zipping job.

Submitting a Multi-File Zipping Job

Feature description

The multi-file zipping feature uses a request to zip multiple files into a compressed file such as a ZIP file. You can submit a job to zip multiple files and asynchronously return the compressed file.

Method prototype

func (s *CIService) CreateFileProcessJob(ctx context.Context, opt *FileProcessJobOptions) (*FileProcessJobResult, *Response, error)

Sample request

createJobOpt := &cos.FileProcessJobOptions{
Tag: "FileCompress",
Operation: &cos.FileProcessJobOperation{
FileCompressConfig: &cos.FileCompressConfig{
Format: "zip",
Flatten: "0",
Key: []string{"1.mp3", "2.jpg"},
},
Output: &cos.FileProcessOutput{
Region: "ap-shanghai",
Bucket: "test-1250000000",
Object: "vvvvxxxzz.zip",
},
},
QueueId: "p111a8dd208104ce3b11c78398f658ca8",
}
res, _, err := c.CI.CreateFileProcessJob(context.Background(), createJobOpt)

Parameter description

type FileProcessJobOptions struct {
XMLName xml.Name
Tag string
Input *FileProcessInput
Operation *FileProcessJobOperation
QueueId string
CallBackFormat string
CallBackType string
CallBack string
CallBackMqConfig *NotifyConfigCallBackMqConfig
}
type FileProcessInput struct {
Region string
Bucket string
Object string
}
type FileProcessJobOperation struct {
FileHashCodeConfig *FileHashCodeConfig
FileHashCodeResult *FileHashCodeResult
FileUncompressConfig *FileUncompressConfig
FileUncompressResult *FileUncompressResult
FileCompressConfig *FileCompressConfig
FileCompressResult *FileCompressResult
Output *FileProcessOutput
UserData string
}
type FileHashCodeConfig struct {
Type string
AddToHeader bool
}
type FileHashCodeResult struct {
MD5 string
SHA1 string
SHA256 string
FileSize int
LastModified string
Etag string
}
type FileUncompressConfig struct {
Prefix string
PrefixReplaced string
}
type FileUncompressResult struct {
Region string
Bucket string
FileCount string
}
type FileCompressConfig struct {
Flatten string
Format string
UrlList string
Prefix string
Key []string
}
type FileCompressResult struct {
Region string
Bucket string
Object string
}
type FileProcessOutput struct {
Region string
Bucket string
Object string
}
type NotifyConfigCallBackMqConfig struct {
MqMode string
MqRegion string
MqName string
}
Parameter
Description
Type
Required
Tag
Job tag, which currently can only be FileCompress.
String
Yes
Input
The object to be processed. For more information, see Input.
Container
Yes
Operation
Operation rule
Container
Yes
Operation.FileCompressConfig
File zipping rule. For more information, see Submitting Multi-File Zipping Job.
Container
Yes
Operation.FileCompressResult
Multi-file zipping result, which will not be returned when the job is not completed. For more information, see Submitting Multi-File Zipping Job.
Container
No
Operation.Output
Address where the output file is stored. For more information, see Submitting Multi-File Zipping Job.
Container
Yes
Operation.UserData
The user information passed through, which is printable ASCII codes of up to 1,024 in length.
String
No
QueueId
ID of the queue where the job is in
String
Yes
CallBackFormat
Job callback format, which can be JSON or XML (default). It takes priority over that of the queue.
String
No
CallBackType
Job callback type, which can be Url (default) or TDMQ. It takes priority over that of the queue.
String
No
CallBack
Job callback address. It takes higher priority over that of the queue.
String
No
CallBackMqConfig
TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ.
Container
No

Response description

type FileProcessJobResult struct {
JobsDetail FileProcessJobResult
}
type FileProcessJobResult struct {
Code string
Message string
JobId string
Tag string
State string
CreationTime string
StartTime string
EndTime string
QueueId string
Input *FileProcessInput
Operation *FileProcessJobOperation
}
Parameter
Description
Type
JobsDetail
Job details
Container
Code
Error code, which will be returned only if State is Failed.
String
Message
Error message, which will be returned only if State is Failed.
String
JobId
Job ID
String
Tag
Job tag: FileCompress
String
State
Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel.
String
CreationTime
Job creation time
String
StartTime
Job start time
String
EndTime
Job end time
String
QueueId
ID of the queue which the job is in
String
Input
Path of the input file for this job. For more information, see FileProcessJobOptions.Input.
Container
Operation
Operation rule. For more information, see FileProcessJobOptions.Operation.
Container

Querying Multi-File Zipping Result

Feature description

This API is used to query the details of a file processing job by job ID.

Method prototype

func (s *CIService) DescribeFileProcessJob(ctx context.Context, jobid string) (*FileProcessJobResult, *Response, error)

Sample request

jobid := "<jobid>"
res, _, err := c.CI.DescribeFileProcessJob(context.Background(), jobid)

Parameter description

Parameter
Description
Type
Required
jobid
File processing job ID
String
Yes

Response description

type FileProcessJobResult struct {
JobsDetail *FileProcessJobsDetail
}
Parameter
Description
Type
JobsDetail
Job details, which is the same as Response.JobsDetail in the CreateFileProcessJob API.
Container

Help and Support

Was this page helpful?

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

Feedback