简介
本文档提供关于数据万象文件解压的 API 概览以及 SDK 示例代码。注意COS Javascript SDK 版本需要大于等于 v1.3.1。
API | 操作描述 |
提交文件解压任务 | 创建一个文件处理解压任务 |
查询文件解压结果 | 查询一个文件处理解压任务 |
提交文件解压任务
功能说明
以提交任务的方式进行文件解压缩,异步返回压缩包内被解压出来的文件。
示例代码
function postFileUnCompressTask() { var config = { // 需要替换成您自己的存储桶信息 Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */ Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */ }; var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_jobs'; var url = 'https://' + host; var body = COS.util.json2xml({ Request: { Tag: 'FileUncompress', // 必须 Input: { Object: 'compressed.zip', // 文件名,取值为文件在当前存储桶中的完整名称 }, Operation: { FileUncompressConfig: { Prefix: '', // 指定解压后输出文件的前缀,不填则默认保存在存储桶根路径 PrefixReplaced: '0', // 指定解压后的文件路径是否需要替换前缀,默认0 }, Output: { Bucket: config.Bucket, // 保存解压后文件的存储桶 Region: config.Region, // 保存解压后文件的存储桶地域 }, }, // CallBack: 'http://callback.demo.com', // 任务回调的地址 // CallBackFormat: 'JSON', // 任务回调格式 // CallBackType: 'Url', // 任务回调类型,Url 或 TDMQ,默认 Url } }); cos.request({ Method: 'POST', Key: 'file_jobs', Url: url, Body: body, ContentType: 'application/xml', }, function(err, data){ console.log(err || data); });}postFileUnCompressTask();
参数说明
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 | 是 |
返回结果说明
详情请参见 提交文件解压任务。
查询文件解压结果
功能说明
查询一个文件处理任务,根据任务 ID 查询任务详情。
示例代码
function getFileUnCompressTask() { var config = { // 需要替换成您自己的存储桶信息 Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */ Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */ }; var jobId = 'xxxxxx'; // 提交文件解压任务后会返回当前任务的 jobId var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_jobs/' + jobId; var url = 'https://' + host; cos.request({ Method: 'GET', Key: 'file_jobs/' + jobId, Url: url, }, function(err, data){ console.log(err || data); });}getFileUnCompressTask();
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 要查询的任务 ID | String | 是 |
返回结果说明
详情请参见 查询文件解压结果。
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145862.html