Intelligent Media Management:CreateFileCompressionTask

• Before using this API, make sure you understand the billing methods and pricing of Intelligent Media Management (IMM).

  Important The completion time of asynchronous tasks is not guaranteed.

• File count limit: You can package up to 80,000 files.

• File size limit: The total size of all files before packaging must not exceed 200 GB.

• This feature supports files of the Standard storage class on OSS. To package files of other storage classes, first convert their storage class.

• This is an asynchronous API. After a task starts, its information is stored for 7 days. After 7 days, the information can no longer be retrieved. To view task information, call the GetTask or ListTasks operation with the returned TaskId. You can also set the Notification parameter to receive task information through asynchronous notification messages.

Examples of packaging rules for typical scenarios

The following examples show how to configure packaging rules for typical scenarios based on the sample file structure:

(bucket)
├── test-dir1
│   ├── file1.txt
│   ├── file2.doc
│   ├── file3.png
│   └── my-file.json
└── test-dir2
    ├── AAA
    │   └── file.txt
    ├── AAA
    ├── file6.doc
    ├── file7.doc
    └── file8.doc

Package a specified directory

To package all files in the test-dir1 directory into a specified directory named test-dir, use the following packaging rule:

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

The structure of the generated compressed file is as follows:

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

Package files with a specified prefix

To package all files with the prefix test-dir1/file into a specified directory named test-dir, use the following packaging rule:

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

The structure of the generated compressed file is as follows:

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

Note that if you use the prefix mode for packaging and the prefix matches both a file and a folder, both the file and the folder are packaged into the compressed file. For example:

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

The structure of the generated compressed file is as follows:

.
└── AAA
    ├── AAA
    └── file.txt

Package specified files

If you do not want to use the prefix mode, set the mode parameter to package only specified files:

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

The structure of the generated compressed file is as follows:

.
├── AAA
└── test-dir1