tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
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
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

文件解压

PDF
聚焦模式
字号
最后更新时间: 2024-11-21 14:29:59

简介

本文档提供关于数据万象文件处理解压任务的相关 API 概览以及 SDK 示例代码。
API
操作描述
创建一个文件处理解压任务
查询一个文件处理解压任务

提交文件解压任务

功能说明

以提交任务的方式进行文件解压缩,异步返回压缩包内被解压出来的文件。

方法原型

public FileProcessJobResponse createFileProcessJob(FileProcessRequest request);

参数说明

Request 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
tag
Request
表示任务的类型,文件解压默认为:FileUncompress。
String
input
Request
包含待操作的文件信息。
Container
operation
Request
包含文件解压的处理规则。
Container
queueId
Request
任务所在的队列 ID。
String
callBackFormat
Request
任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式。
String
callBackType
Request
任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型。
String
callBack
Request
任务回调的地址,优先级高于队列的回调地址。
String
callBackMqConfig
Request
任务回调 TDMQ 配置,当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig
Container
Input 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
object
Request.Input
文件名,取值为文件在当前存储桶中的完整名称。
String
operation 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
fileUncompressConfig
Request.Operation
指定文件解压的处理规则。
Container
userData
Request.Operation
透传用户信息, 可打印的 ASCII 码, 长度不超过1024
String
output
Request.Operation
指定解压后的文件保存的存储桶信息。
Container
FileUncompressConfig 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
prefix
Request.Operation.FileUncompressConfig
指定解压后输出文件的前缀,不填则默认保存在存储桶根路径。
String
prefixReplaced
Request.Operation.FileUncompressConfig
指定解压后的文件路径是否需要替换前缀,有效值:
- 0:不添加额外的前缀,解压缩将保存在Prefix指定的路径下(不会保留压缩包的名称,仅将压缩包内的文件保存至指定的路径)。
- 1:以压缩包本身的名称作为前缀,解压缩将保存在Prefix指定的路径下。
- 2:以压缩包完整路径作为前缀,此时如果不指定Prefix,就是解压到压缩包所在的当前路径(包含压缩包本身名称)。
- 默认值为0。
String
示例:
假设压缩包名为 test.zip,压缩包内的文件为“图片.jpg”,存储在了存储桶 A 的 123 目录下,则压缩包的完整路径为:123/test.zip。 对该压缩包进行解压缩,指定解压缩到存储桶A,并指定 Prefix 为 456,则不同的PrefixReplaced值对应解压后的文件保存情况如下: 0:“图片.jpg”会保存在 456 目录下,“图片.jpg”的完整路径为 456/图片.jpg; 1:“图片.jpg”会以 test 为前缀保存在 456 目录下,“图片.jpg”的完整路径为 456/test/图片.jpg; 2:“图片.jpg”会以 123/test 为前缀保存在 456 目录下,“图片.jpg”的完整路径为 456/123/test/图片.jpg。
Output 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
region
Request.Operation.Output
存储桶的地域。
String
bucket
Request.Operation.Output
保存解压后文件的存储桶。
String

返回结果说明

成功:返回 FileProcessJobResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

请求示例

//1.创建任务请求对象
FileProcessRequest request = new FileProcessRequest();
//2.添加请求参数 参数详情请见 api 接口文档
request.setBucketName("demo-1234567890");
request.setTag(FileProcessJobType.FileUncompress);
request.getInput().setObject("output/demo.zip");
FileUnCompressConfig fileUnCompressConfig = request.getOperation().getFileUnCompressConfig();
fileUnCompressConfig.setPrefix("output/");
fileUnCompressConfig.setPrefixReplaced("1");
request.setQueueId("p1ff062b35a494cf0ac4b572df22a5650");
MediaOutputObject output = request.getOperation().getOutput();
output.setBucket("demo-1234567890");
output.setRegion("ap-shanghai");
//3.调用接口,获取任务响应对象
FileProcessJobResponse response = client.createFileProcessJob(request);

查询文件解压结果

功能说明

查询一个文件处理任务,根据任务 ID 查询任务详情。

方法原型

public FileProcessJobResponse describeFileProcessJob(FileProcessRequest request);

参数说明

参数名称
描述
类型
是否必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
jobId
要查询的任务 ID
String

返回结果说明

成功: 返回任务详情响应包装类,类中包含一个 FileProcessJobResponse 任务详情对象。
失败: 发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

请求示例

//1.创建任务请求对象
FileProcessRequest request=new FileProcessRequest();
//2.添加请求参数 参数详情请见 api 接口文档
request.setBucketName("demo-1234567890");
request.setJobId("fda7eb1607b8411ed8c182156726*****");
//3.调用接口,获取任务响应对象
FileProcessJobResponse response=client.describeFileProcessJob(request);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈