文档

CreateFileCompressionTask - 创建文件压缩任务

文件压缩任务可以将您的多个文件,打包为zip等压缩包。您提交任务后会异步打包文件,将结果存储到指定位置。在打包时支持对文件进行重命名操作,您可以自定义文件打包规则以及输出的压缩包名称。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

  • 文件数量限制:最多支持打包 8 万个文件。

  • 文件大小限制:打包压缩前所有文件大小不超过 200 GB。

  • 该功能支持 OSS 上的标准存储类型文件,如需要打包压缩其他类型文件,请先转化文件的存储类型

  • 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTaskListTasks 接口获取返回的TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
Sourcesobject []

待压缩的文件列表和打包规则描述。

说明 与参数SourceManifestURI二选一。
URIstring

待压缩的目录或文件的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object} 说明如下:

  • 压缩目录时,${Object}为目录名称。

  • 压缩文件时,${Object}为包含文件扩展名的文件完整路径。

oss://test-bucket/test-object
Aliasstring

重定向待压缩文件在压缩包中的文件路径或重命名文件。

  • 不填写该参数。保留源目录结构进行压缩,例如源文件地址为oss://test-bucket/test-dir/test-object.doc,则压缩包中文件路径为/test-dir/test-object.doc

  • 重命名文件。重命名压缩包中的文件名称,例如源文件地址为oss://test-bucket/test-object.jpg,指定参数 Aliastest-rename-object.jpg,则压缩包中文件名称为test-rename-object.jpg

  • 重新指定源文件在压缩包中的文件路径。例如源目录地址为oss://test-bucket/test-dir/,指定参数 Alias/new-dir/,则源目录下所有文件都会被压缩到路径/new-dir/中。

  • 指定为/,去除源目录结构。

说明 请避免在重命名过程中出现重名文件的情况,出现此情况时压缩包内的重名文件可能无法解压(取决于您使用的解压程序)。
/new-dir/
Modestring

指定打包规则的匹配模式,包括prefix(表示前缀模式)和fullname(表示精准匹配),默认为prefix

  • prefix:前缀模式,解析该条打包规则时,前缀模式匹配所有符合规则的文件。
  • fullname:精准匹配,按照规则精准匹配文件,只会匹配到一个文件。
fullname
CredentialConfigCredentialConfig

链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

SourceManifestURIstring

文件清单存储的地址。文件清单将 Sources 结构以 JSON 格式存储在 OSS 上,适用于打包文件较多的情况。

说明 与参数Sources二选一。其中URI参数必填,Alias参数选填,该文件内部结构示例:
[{"URI":"oss://<bucket>/<object>", "Alias":"/new-dir/new-name"}]
oss://test-bucket/test-object.json
TargetURIstring

输出文件的 OSS 地址。压缩文件将以该路径中的文件名称命名,例如name.zip

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://test-bucket/test-target-object.zip
CompressedFormatstring

文件打包压缩类型,默认值为 zip。

说明 目前仅支持 zip 格式。
zip
UserDatastring

用户自定义信息,在异步消息通知中会为您返回,方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

test-data
NotificationNotification

消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式

典型场景中打包规则举例

对于如下示例的文件结构,对一些经典的场景示例说明:

(bucket)
├── test-dir1
│   ├── file1.txt
│   ├── file2.doc
│   ├── file3.png
│   └── my-file.json
└── test-dir2
    ├── AAA
    │   └── file.txt
    ├── AAA
    ├── file6.doc
    ├── file7.doc
    └── file8.doc
对指定文件夹进行打包

打包test-dir1下的所有文件打包到指定目录test-dir中,打包规则:

[
    {
        "URI"   : "oss://bucket/test-dir1/",
        "Alias" : "/test-dir/"
    }
]

生成的压缩包结构为:

.
└── test-dir
    ├── file1.txt
    ├── file2.doc
    ├── file3.png
    └── my-file.json
对指定前缀进行打包

打包前缀为test-dir1/file下的所有文件打包到指定目录test-dir中,打包规则:

[
    {
        "URI"   : "oss://bucket/test-dir1/file",
        "Alias" : "/test-dir/"
    }
]

生成的压缩包结构为:

.
└── test-dir
    ├── file1.txt
    ├── file2.doc
    └── file3.png

注意,如果使用前缀模式进行打包,会将同名的文件夹/文件同时打包进压缩包,例如:

[
    {
        "URI"   : "oss://bucket/test-dir2/AAA",
        "Alias" : "/AAA/"
    }
]

生成的压缩包结构为:

.
└── AAA
    ├── AAA
    └── file.txt
对指定的文件进行打包

如果不想使用前缀模式,可以通过设置mode参数准确的打包指定的文件:

[
    {
        "URI"   : "oss://bucket/test-dir2/AAA",
        "Alias" : "AAA",
        "mode"  : "fullname",
    },
    {
        "URI"   : "oss://bucket/test-dir1/",
        "Alias" : "/test-dir1/",
        "mode"  : "fullname",
    }
]

生成的压缩包结构为:

.
├── AAA
└── test-dir1

返回参数

名称类型描述示例值
object

响应结构体

RequestIdstring

请求 ID。

EC564A9A-BA5C-4499-A087-D9B9E76E*****
EventIdstring

事件 ID。

0ED-1Bz8z71k5TtsUejT4UJ16Es*****
TaskIdstring

任务 ID。

FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****

示例

正常返回示例

JSON格式

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-20API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-05-12OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:Password
2023-04-03OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:NotifyTopicName
2023-03-09OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Notification
  • 本页导读 (1)
文档反馈