简介
文件解压功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于文件解压的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.1.1。
提交文件解压任务
功能说明
以提交任务的方式进行文件解压缩,异步返回压缩包内被解压出来的文件,该接口属于 POST 请求
使用示例
function createFileUnCompressJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `jobs` //const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 表示任务的类型,文件解压默认为:FileUncompress。;是否必传:是Tag: "FileUncompress",// 包含待操作的文件信息。;是否必传:是Input: {// 文件名,取值为文件在当前存储桶中的完整名称。;是否必传:是Object: "test.zip",},// 包含文件解压的处理规则。;是否必传:是Operation: {// 指定文件解压的处理规则。;是否必传:是FileUncompressConfig: {// 指定解压后输出文件的前缀,不填则默认保存在存储桶根路径。;是否必传:否Prefix: "output/",// 解压密钥,传入时需先经过 base64 编码。;是否必传:否UnCompressKey: "",// 指定解压后的文件路径是否需要替换前缀,有效值:0:不添加额外的前缀,解压缩将保存在Prefix指定的路径下(不会保留压缩包的名称,仅将压缩包内的文件保存至指定的路径)1:以压缩包本身的名称作为前缀,解压缩将保存在Prefix指定的路径下2:以压缩包完整路径作为前缀,此时如果不指定Prefix,就是解压到压缩包所在的当前路径(包含压缩包本身名称)默认值为0。;是否必传:否PrefixReplaced: "",},// 透传用户信息,可打印的 ASCII 码,长度不超过1024。;是否必传:否UserData: "",// 指定解压后的文件保存的存储桶信息。;是否必传:是Output: {// 存储桶的地域。;是否必传:是Region: config.Region,// 保存解压后文件的存储桶。;是否必传:是Bucket: config.Bucket,},},// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式。;是否必传:否CallBackFormat: "",// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型。;是否必传:否CallBackType: "Url",// 任务回调的地址,优先级高于队列的回调地址。;是否必传:否CallBack: "",}});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}createFileUnCompressJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:jobs | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
查询文件解压结果
功能说明
本接口用于主动查询指定的文件解压任务结果
使用示例
function describeFileUnCompressJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const jobId = "xxx";const key = `file_jobs/${jobId}` // jobId:{jobId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeFileUnCompressJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | file_jobs/{jobId} | String | 是 |
回调函数说明
function(err, data) { ... }