Retrieving Archived Files

Retrieving Archived Files - restore

Last updated: 2025-05-09 18:27:39

Retrieving Archived Files - restore

Last updated: 2025-05-09 18:27:39

The restore command is used to restore archived objects.
Note: 
If you need to use this command, when you perform authorization policy, set action to cos:HeadBucket, cos:GetBucket, cos:PostObjectRestore. For more authorizations, please refer to CAM-Enabled API.
Command Syntax
./coscli restore cos://<bucket-name>[/prefix/] [flag]
restore includes the following parameters:
Parameter Format
Description
Example
cos://<bucket-name>
Specifies the target bucket, which is accessible by using the bucket alias or bucket name configured in the configuration file as detailed in Download and Installation Configuration. If you use the bucket name for access, you also need to include the endpoint flag.
Access with the bucket alias: cos://example-alias
Access with the bucket name: cos://examplebucket-1250000000
/prefix/
Specifies a directory (optional).
/picture/
The restore command contains the following optional flags:
Flag Abbreviation
Flag Name
Description
-h
--help
Views the usage of this command.
None
--include
Includes specific objects.
None
--exclude
Excludes specific objects.
-d
--days
Specifies the expiration time of the temporary file generated during object restoration, which is 3 days by default.
-m
--mode
Specifies the restoration mode, which is Standard by default
If the data to be recovered is of the archive storage type, the available values are Expedited, Standard, and Bulk, which correspond to expedited retrieval mode, standard retrieval mode, and bulk retrieval mode respectively.
If the data being restored is of deep archive storage type, the optional values are Standard, Bulk.
-r
--recursive
Traverses the folder recursively.
None
--fail-output
This option determines whether to enable the error output of files when reheating fails (enabled by default true). If enabled, the failure of file reheating will be recorded in the specified directory (if not specified, defaults to ./coscli_output). If disabled, only the quantity of error files will be output to the console.
None
--fail-output-path
This option is used to specify the error output folder for recording failed reheating files. By providing a custom folder path, you can control the location and name of the error output folder. If this option is not set, the default error log folder ./coscli_output will be used.
Note: 
--include and --exclude support standard regular expression syntax, so you can use them to filter out objects that meet specific criteria.
When using zsh, you may need to add double quotes at both ends of the pattern string.
  ./coscli restore cos://bucket1/example/ -r --include ".*\\.mp4$"
For more general options for this command (such as switching buckets or user accounts), see Common Options.
For more information on retrieving archived files, see POST Object restore.
Examples
Restoring archived objects in bucket1 bucket in Standard mode
./coscli restore cos://bucket1/picture.jpg
Restoring all archived objects in picture folder in bucket1 bucket in Expedited mode
./coscli restore cos://bucket1/picture/ -r --mode Expedited

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud

Command Syntax

Examples

Restoring archived objects in `bucket1` bucket in Standard mode

Restoring all archived objects in `picture` folder in `bucket1` bucket in Expedited mode

Parameter Format	Description	Example
cos://<bucket-name>	Specifies the target bucket, which is accessible by using the bucket alias or bucket name configured in the configuration file as detailed in Download and Installation Configuration. If you use the bucket name for access, you also need to include the `endpoint` flag.	Access with the bucket alias: cos://example-alias Access with the bucket name: cos://examplebucket-1250000000
/prefix/	Specifies a directory (optional).	/picture/

Flag Abbreviation	Flag Name	Description
-h	--help	Views the usage of this command.
None	--include	Includes specific objects.
None	--exclude	Excludes specific objects.
-d	--days	Specifies the expiration time of the temporary file generated during object restoration, which is 3 days by default.
-m	--mode	Specifies the restoration mode, which is `Standard` by default If the data to be recovered is of the archive storage type, the available values are Expedited, Standard, and Bulk, which correspond to expedited retrieval mode, standard retrieval mode, and bulk retrieval mode respectively. If the data being restored is of deep archive storage type, the optional values are Standard, Bulk.
-r	--recursive	Traverses the folder recursively.
None	--fail-output	This option determines whether to enable the error output of files when reheating fails (enabled by default `true`). If enabled, the failure of file reheating will be recorded in the specified directory (if not specified, defaults to `./coscli_output`). If disabled, only the quantity of error files will be output to the console.
None	--fail-output-path	This option is used to specify the error output folder for recording failed reheating files. By providing a custom folder path, you can control the location and name of the error output folder. If this option is not set, the default error log folder `./coscli_output` will be used.