数据万象
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据万象 > SDK 文档 > PHP SDK > 文件处理 > 多文件打包压缩

多文件打包压缩

最近更新时间：2024-01-23 14:13:01

我的收藏

本页目录：

简介

本文档提供关于多文件打包压缩接口的 API 概览和 SDK 示例代码。
API
操作描述
多文件打包压缩功能可以将您的多个文件，打包为 zip 等压缩包格式，以提交任务的方式进行多文件打包压缩，异步返回打包后的文件，该接口属于 POST 请求。
本接口用于主动查询指定的多文件打包压缩任务结果。

提交多文件打包压缩任务

功能说明

多文件打包压缩功能可以将您的多个文件，打包为 zip 等压缩包格式，以提交任务的方式进行多文件打包压缩，异步返回打包后的文件，该接口属于 POST 请求。

方法原型

public Guzzle\\Service\\Resource\\Model createFileCompressJobs(array $args = array());

请求示例

<?php

require dirname(__FILE__, 2) . '/vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // https://cloud.tencent.com/document/product/436/83112 提交多文件打包压缩任务-异步
    $result = $cosClient->createFileCompressJobs(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'FileCompress',
//        'QueueId' => 'pcc3ae89sa9d807fs89dg789sdg',
        'Operation' => array(
            'UserData' => 'xxx',
            'FileCompressConfig' => array(
                'Flatten' => '0',
                'Format' => 'zip',
//                'UrlList' => 'test/index.csv',
//                'Prefix' => 'test/',
                'Keys' => array(
                    'object1', // 待压缩桶文件
                    'object2', // 待压缩桶文件
                    'object3', // 待压缩桶文件
                ),
            ),
            'Output' => array(
                'Region' => $region,
                'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
                'Object' => 'output/test.zip',
            ),
        ),
//        'CallBackFormat' => '',
//        'CallBackType' => '',
//        'CallBack' => '',
//        'CallBackMqConfig' => array(
//            'MqRegion' => '',
//            'MqMode' => '',
//            'MqName' => '',
//        ),
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
表示任务的类型，多文件打包压缩默认为：FileCompress。
String
是
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
否
Container 类型 Operation 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
FileCompressConfig
Request.Operation
指定文件打包压缩的处理规则。
Container
是
UserData
Request.Operation
透传用户信息, 可打印的 ASCII 码, 长度不超过1024
String
否
Output
Request.Operation
指定打包压缩后的文件保存的地址信息。
Container
是
Container 类型 FileCompressConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Flatten
Request.Operation.FileCompressConfig
文件打包时，是否需要去除源文件已有的目录结构，有效值：
0：不需要去除目录结构，打包后压缩包中的文件会保留原有的目录结构；
1：需要，打包后压缩包内的文件会去除原有的目录结构，所有文件都在同一层级。 例如：源文件 URL 为 https://domain/source/test.mp4, 则源文件路径为 source/test.mp4，如果为 1，则 ZIP 包中该文件路径为 test.mp4；如果为0， ZIP 包中该文件路径为 source/test.mp4。
String
是
Format
Request.Operation.FileCompressConfig
打包压缩的类型，有效值：zip、tar、tar.gz。
String
是
UrlList
Request.Operation.FileCompressConfig
支持将需要打包的文件整理成索引文件，后台将根据索引文件内提供的文件url，打包为一个压缩包文件。索引文件需要保存在当前存储桶中，本字段需要提供索引文件的对象地址，例如：/test/index.csv。
索引文件格式：仅支持 CSV 文件，一行一条URL（仅支持本存储桶文件），如有多列字段，默认取第一列作为URL。最多不超过10000个文件, 总大小不超过50G, 否则会导致任务失败。
String
否
Prefix
Request.Operation.FileCompressConfig
支持对存储桶中的某个前缀进行打包，如果需要对某个目录进行打包，需要加/，例如test目录打包，则值为：test/。最多不超过10000个文件，总大小不超过50G，否则会导致任务失败。
String
否
Key
Request.Operation.FileCompressConfig
支持对存储桶中的多个文件进行打包，个数不能超过 1000, 总大小不超过50G，否则会导致任务失败。
String 数组
否
注意：
UrlList、Prefix、Key 三者仅能选择一个，不能都为空，也不会同时生效。如果填了多个，会按优先级 UrlList > Prefix > Key 取最高优先级执行。
Container 类型 Output 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Region
Request.Operation.Output
存储桶的地域。
String
是
Bucket
Request.Operation.Output
保存压缩后文件的存储桶。
String
是
Object
Request.Operation.Output
压缩后文件的文件名
String
是

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjNkOGM2NmVfZTYxNmY5MSAASJPOJCIANSIDNAI=
    [ContentType] => application/xml
    [ContentLength] => 827
    [JobsDetail] => Array
        (
            [Progress] => 0
            [Code] => Success
            [Message] => 
            [JobId] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
            [Tag] => FileCompress
            [State] => Submitted
            [CreationTime] => 2023-01-31T16:17:21+0800
            [StartTime] => -
            [EndTime] => -
            [QueueId] => pcc3ae89sa9d807fs89dg789sdg
            [Operation] => Array
                (
                    [JobLevel] => 0
                    [UserData] => xxx
                    [Output] => Array
                        (
                            [Region] => ap-guangzhou
                            [Bucket] => examplebucket-1250000000
                            [Object] => tmp/test.zip
                        )

                    [FileCompressConfig] => Array
                        (
                            [Flatten] => 0
                            [Format] => zip
                            [UrlList] => 
                            [Prefix] => 
                            [Key] => Array
                                (
                                    [0] => test1.png
                                    [1] => test2.jpeg
                                )

                        )

                )

        )

    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/file_jobs
)

查询多文件打包压缩结果

功能说明

本接口用于主动查询指定的多文件打包压缩任务结果。

方法原型

public Guzzle\\Service\\Resource\\Model getFileCompressResult(array $args = array());

请求示例

<?php

require dirname(__FILE__, 2) . '/vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部，默认为http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // https://cloud.tencent.com/document/product/436/83113 查询多文件打包压缩结果
    $result = $cosClient->getFileCompressResult(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => '', // jobId
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
参数名称
类型
描述
是否必填
Bucket
String
存储桶名称，格式：BucketName-APPID
是
Key
String
jobId
是

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjNkOGM2NmVfZTYxNmY5MSAASJPOJCIANSIDNAI=
    [ContentType] => application/xml
    [ContentLength] => 1093
    [JobsDetail] => Array
        (
            [Progress] => 100
            [Code] => Success
            [Message] => success
            [JobId] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
            [Tag] => FileCompress
            [State] => Success
            [CreationTime] => 2023-01-31T16:17:21+0800
            [StartTime] => 2023-01-31T16:17:21+0800
            [EndTime] => 2023-01-31T16:17:22+0800
            [QueueId] => pcc3ae89sa9d807fs89dg789sdg
            [Operation] => Array
                (
                    [JobLevel] => 0
                    [UserData] => xxx
                    [Output] => Array
                        (
                            [Region] => ap-guangzhou
                            [Bucket] => examplebucket-1250000000
                            [Object] => tmp/test.zip
                        )

                    [FileCompressConfig] => Array
                        (
                            [Flatten] => 0
                            [Format] => zip
                            [UrlList] => 
                            [Prefix] => 
                            [Key] => Array
                                (
                                    [0] => test1.png
                                    [1] => test2.jpeg
                                )

                        )

                    [FileCompressResult] => Array
                        (
                            [CompressFileCount] => 2
                            [Region] => ap-guangzhou
                            [Bucket] => examplebucket-1250000000
                            [Object] => tmp/test.zip
                        )

                )

        )

    [Key] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/file_jobs/fcd32dbdaa13b11esa9ds8g0d98gd0h85
)

中国站