tencent cloud

Cloud Infinite

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Product Overview
Product Strengths
Use Cases
Feature Overview
Regions and Domains
Specifications and Limits
Billing
Billing Overview
Billing Mode
Billable Items
Free Tier
Payment Overdue
Viewing Bill Details
FAQs
Getting Started
Registering and Logging In
Bind Bucket
Uploading and Processing File
Downloading and Deleting Images
Unbinding Buckets
Using CI via COS
Features
Image Processing
Media Processing
Content Moderation
AI Content Recognition
File Processing
Smart Voice
File processing
User Guide
Overview
Bucket Management
Smart Toolbox
Job and Workflow
Data Monitoring
Usage statistics
Use Cases
Copyright Protection Solutions
Image Processing Practices
Working with API Authorization Policies
Workflow Practices
API Documentation
API Overview
Structure
Common Request Headers
Common Response Headers
Activate Vast Service
Image Processing
AI-Based Content Recognition
Smart Audio
Media Processing
Content Moderation
Document Processing
File Processing
Job and Workflow
Cloud Virus Detection
Error Codes
Request Signature
SDK Documentation
SDK Overview
Android SDK
iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
Mini Program SDK
Personal Information Protection Policy for SDK
Security and Compliance
Permission ‍Management
FAQs
Basic Settings
Document Processing
Media Processing
Content Recognition
Smart Audio
Agreements
Service Level Agreement
Contact Us
Glossary

Multi-File Zipping

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2024-02-29 16:52:32

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 type, which currently can only be FileCompress.
String
Yes
Input
The object to be processed. For more information, see Submitting Hash Calculation Job.
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 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 where 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


Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan