CreateFileCompressionTask_智能媒体管理_API文档-阿里云OpenAPI开发者门户

接口说明

说明接口公测中，如有任何使用问题，请使用钉钉搜索钉钉群号 88490020073 加入钉钉群进行反馈。

说明该接口目前支持打包，不支持压缩，后续会增加压缩功能。

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
注意异步任务不保证时效。
文件数量限制：最多支持打包 8 万个文件。
文件大小限制：打包前所有文件大小不超过 200 GB。
该功能支持 OSS 上的标准存储类型文件，如需要打包其他类型文件，请先转化文件的存储类型。
该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

imm:CreateFileCompressionTask	Create	Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}	无	无

请求参数

字段名称	字段详情
ProjectNamestring	项目名称，获取方式请参见创建项目。示例值:test-project参考取值来源: UpdateProject CreateProject ListProjects
Sourcesarray<object>	待打包的文件列表和打包规则描述。展开详情
CredentialConfigCredentialConfig	链式授权配置对象，一般留空即可。展开详情
SourceManifestURIstring	文件清单存储的地址。文件清单将 Sources 结构以 JSON 格式存储在 OSS 上，适用于打包文件较多的情况。展开详情示例值:oss://test-bucket/test-object.json
TargetURIstring	输出文件的 OSS 地址。压缩文件将以该路径中的文件名称命名，例如`name.zip`。展开详情示例值:oss://test-bucket/test-target-object.zip参考取值来源: CreateImageToPDFTask
CompressedFormatstring	文件打包压缩类型，默认值为 zip。展开详情示例值:zip枚举值:
UserDatastring	用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。示例值:test-data
NotificationNotification	消息通知对象，支持多种消息中间件，消息格式详情请见异步通知消息格式，请选择其中一种方式接收消息，使用方式如下所示：展开详情

请求说明

典型场景中打包规则举例

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

（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

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:EC564A9A-BA5C-4499-A087-D9B9E76E*****
EventIdstring	事件 ID。示例值:0ED-1Bz8z71k5TtsUejT4UJ16Es*****
TaskIdstring	任务 ID。示例值:FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-11-20	变更请求参数Sources
	2023-05-12	删除请求参数Password
	2023-04-03	删除请求参数NotifyTopicName
	2023-03-09	新增请求参数Notification
	2022-10-28	删除请求参数ManifestURI 新增请求参数SourceManifestURI

CreateFileCompressionTask_智能媒体管理_API文档

接口说明

流控信息

授权信息

请求参数

请求说明

典型场景中打包规则举例

对指定文件夹进行打包

对指定前缀进行打包

对指定的文件进行打包

返回参数

返回示例

变更历史

相关示例