Archives files and folders into a package for download.
Operation description
This asynchronous operation archives files and folders into a single package and returns an asynchronous task ID. To check the status of the task, call GetAsyncTask.
Try it now
Test
RAM authorization
Request syntax
POST /v2/file/archive_files HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| domain_id |
string |
Yes |
The domain ID. |
bj1 |
| body |
object |
No |
The parameters in the request body. |
|
| share_id |
string |
No |
The share ID. This parameter is required when archiving files from a share. |
7JQX1FswpQ8 |
| drive_id |
string |
No |
The ID of the drive that contains the files. You must specify either this parameter or |
1 |
| file_ids |
array |
Yes |
The list of files to be archived. |
|
|
string |
Yes |
The ID of the file or folder to archive. |
63e5e4340f76cb3ead5f40f68163f0f967c1a7bf |
|
| name |
string |
Yes |
The name of the generated archive file. The name must be UTF-8 encoded. |
test_archive_files.zip |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| async_task_id |
string |
The asynchronous task ID. |
000e89fb-cf8f-11e9-8ab4-b6e980803a3b |
Examples
Success response
JSON format
{
"async_task_id": "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.