On this page

Show all

Help Center/ Object Storage Service/ Tool Guide (obsutil) (Paris Region)/ Object Commands/ Restoring Objects from the Cold Storage

Restoring Objects from the Cold Storage

Updated on 2025-02-10 GMT+08:00

View PDF

Function

You can use this command to restore a specified cold object or restore cold objects with a specific prefix in batches.

NOTE:

Object content cannot be read during restoration.
After an object is restored, the time it requires before the object can be downloaded depends on the OBS server.

Command Line Structure

In Windows

Restoring an object

obsutil restore obs://bucket/key [-d=1] [-t=xxx] [-versionId=xxx] [-fr] [-o=xxx] [-config=xxx]

Restoring objects in batches

obsutil restore obs://bucket[/key] -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx]

Restoring all objects in a specific directory at a time

obsutil restore obs://bucket/folder/ -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx]

In Linux or macOS

Restoring an object

./obsutil restore obs://bucket/key [-d=1] [-t=xxx] [-versionId=xxx] [-fr] [-o=xxx] [-config=xxx]

Restoring objects in batches

./obsutil restore obs://bucket[/key] -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx]

Restoring all objects in a specific directory at a time

./obsutil restore obs://bucket/folder/ -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx]

Examples

Take the Windows OS as an example. Run the obsutil restore obs://bucket-test/key command to restore a single object whose storage class is cold.

obsutil restore obs://bucket-test/key
Start at 2024-09-30 08:56:17.9537365 +0000 UTC

Start to restore object [key] in the bucket [bucket-test] successfully, cost [252] ms, request id [0000019242250F754015F23EE0B7876E]

Take the Windows OS as an example. Run the obsutil restore obs://bucket-test -r -f command to restore objects whose storage class is cold in the bucket in batches.

obsutil restore obs://bucket-test -r -f
Start at 2024-09-30 08:57:11.3565648 +0000 UTC

[================================================] 100.00% 3s
Succeed count:   12        Failed count:    0
Metrics [max cost:264 ms, min cost:54 ms, average cost:119.33 ms, average tps:19.70]
Task id: 96f104ee-d0bf-40ff-95dd-31dec0d8f4f4

Parameter Description

Parameter	Optional or Mandatory	Description
bucket	Mandatory	Bucket name
key	Mandatory for restoring a single object whose storage class is cold Optional for batch restoring objects whose storage class is cold	Indicates the name of the object to be restored or the name prefix of the objects to be restored in batches. NOTE: If this parameter is left blank when batch restoring objects, all objects whose storage class is cold in the bucket are restored.
d	Optional (additional parameter)	Storage duration after objects whose storage class is cold are restored, in days. The value ranges from 1 to 30. The default value is 1.
t	Optional (additional parameter)	Options for restoring objects. Possible values are: standard expedited NOTE: expedited indicates that objects can be quickly restored from Archive storage within 1 to 5 minutes. standard indicates that objects can be restored from Archive storage within 3 to 5 hours. If this parameter is not configured, an expedited restore is used by default.
versionId	Optional for restoring a single object whose storage class is cold (additional parameter)	Version ID of the to-be-restored object whose storage class is cold
fr	Optional for restoring a single object whose storage class is cold (additional parameter)	Generates an operation result list when restoring a single object whose storage class is cold.
f	Optional for batch restoring objects whose storage class is cold (additional parameter)	Runs in force mode.
r	Mandatory for batch restoring objects whose storage class is cold (additional parameter)	Restores objects whose storage class is cold in batches by object name prefix.
v	Optional for batch restoring objects whose storage class is cold (additional parameter)	Restores versions of objects whose storage class is cold in batches by object name prefix.
o	Optional (additional parameter)	Indicates the folder where operation result lists reside. After the command is executed, result lists (possibly including success and failure files) are generated in the folder. The default value is .obsutil_output, the subfolder in the home directory of the user who executes obsutil commands. NOTE: The naming rule for result lists is as follows: restore_{succeed \| failed}_report_time_TaskId.txt By default, the maximum size of a single result list is 30 MB and the maximum number of result lists that can be retained is 1024. You can set the maximum size and number by configuring recordMaxLogSize and recordBackups in the configuration file.
j	Optional for batch restoring objects whose storage class is cold (additional parameter)	Maximum number of concurrent tasks for batch restoring objects whose storage class is cold. The default value is the value of defaultJobs in the configuration file. NOTE: The value is ensured to be greater than or equal to 1.
config	Optional (additional parameter)	User-defined configuration file for executing the current command. To learn the parameters that can be configured in this file, see Configuration Parameters.

Response

Refer to Response for uploading an object.

Parent topic: Object Commands

Previous topic: Synchronously Downloading Incremental Objects

Next topic: Resuming a Failed Upload Task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot