文件压缩任务可以将您的多个文件,打包为zip等压缩包。您提交任务后会异步打包文件,将结果存储到指定位置。在打包时支持对文件进行重命名操作,您可以自定义文件打包规则以及输出的压缩包名称。
接口说明
-
请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。
-
文件数量限制:最多支持打包8万个文件。
-
文件大小限制:打包压缩前所有文件大小不超过200 GB。
-
该功能支持OSS上的标准存储类型文件,如需要打包压缩其他类型文件,请先转化文件的存储类型。
-
该接口为异步接口,获取任务开始执行后,任务信息只保存7天,超过7天则无法再获取。调用GetTask或ListTasks接口获取返回的
TaskId
,查看任务信息。也可以通过设置Notification消息通知参数,通过消息通知获取任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 项目名称,获取方式请参见创建项目。 | test-project |
Sources | object [] | 否 | 待压缩的文件列表和打包规则描述。 说明
与参数 SourceManifestURI 二选一。
| |
URI | string | 否 | 待压缩的目录或文件的OSS地址。 OSS地址规则为oss://${Bucket}/${Object},其中
| oss://test-bucket/test-object |
Alias | string | 否 | 重定向待压缩文件在压缩包中的文件路径或重命名文件。
说明
请避免在重命名过程中出现重名文件的情况,出现此情况时压缩包内的重名文件可能无法解压(取决于您使用的解压程序)。
| /new-dir/ |
CredentialConfig | CredentialConfig | 否 | 链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源。 | |
SourceManifestURI | string | 否 | 文件清单存储的地址。文件清单将Sources结构以JSON格式存储在OSS上,适用于打包文件较多的情况。 说明
与参数 Sources 二选一。其中URI 参数必填,Alias 参数选填,该文件内部结构示例:
| oss://test-bucket/test-object.json |
TargetURI | string | 是 | 输出文件的OSS地址。压缩文件将以该路径中的文件名称命名,例如 OSS地址规则为oss://${Bucket}/${Object},其中 | oss://test-bucket/test-target-object.zip |
CompressedFormat | string | 否 | 文件打包压缩类型,默认值为zip。 说明
目前仅支持zip格式。
| zip |
UserData | string | 否 | 用户自定义信息,在异步消息通知中会为您返回,方便您系统内对消息通知进行关联处理。最大长度为2048字节。 | test-data |
Notification | Notification | 否 | 消息通知配置,详细内容请单击Notification查看,异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
"TaskId": "FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-11-20 | API 内部配置变更,不影响调用 | 看变更集 | ||||
| ||||||
2023-05-12 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-04-03 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-03-09 | OpenAPI 入参发生变更 | 看变更集 | ||||
|