Help Center/ Object Storage Service/ User Guide/ Object Management/ Object Management/ Restoring Archive or Deep Archive Objects

Updated on 2025-09-15 GMT+08:00

View PDF

Restoring Archive or Deep Archive Objects

Scenarios

You must restore an object in the Archive or Deep Archive storage class before you can download it or access it with a URL.

To learn the costs involved in data restore, see Product Pricing Details.

Important Notes

After an object is restored, an object copy in the Standard storage class will be generated. This way, there is an Archive or a Deep Archive object and a Standard object copy in the bucket at the same time. After an Archive or Deep Archive object is restored, the object status displays Restored, and the generated object copy in Standard storage class is not displayed in the bucket.

After versioning is enabled, if you do not specify a version ID, OBS restores the current version. You can specify a version ID to restore a specific version.
If the RestoreObject API is called for the first time, 202 will be returned, indicating that the server has received the request. If the RestoreObject API is called again after a successful object restore, 200 OK will be returned.

Constraints

Archive and Deep Archive objects can remain in a restored state for a maximum of 30 days.
If an Archive or a Deep Archive object is being restored, its restore speed cannot be changed, and the restore task cannot be suspended or deleted.
If you attempt to restore an object that is being restored, error 409 will be reported. Wait for the current restore to finish before trying again.
Objects that are being restored cannot be added to a batch restore.

Object Restore Option and Time Required

OBS provides the following restore options.

To restore a large number of objects from the Deep Archive storage class, you are advised to use the standard restore. The restore time spent depends on the object size restored.

Storage Class	Restore Option	Time Required
Archive	Expedited	1 to 5 minutes
Archive	Standard	3 to 5 hours
Deep Archive	Expedited	3 to 5 hours
Deep Archive	Standard	5 to 12 hours

How Object Restore Works

Object Restore Process

Archive and Deep Archive objects have the same restore process. The following gives an example:

Before a restore, an object is in the unrestored state.
On July 1, you submit the first restore request. The object enters the restoring state.
On July 1, the server completes the restore operation. The object enters the restored state and becomes readable. Assume that you set the validity period to 10 days this time. The object will remain in the restored state until July 10.
On July 5, you make another restore request for the object and set the validity period to 10 days. The object will then remain in the restored state until July 15, with a total validity period of 15 days.
Once the validity period is reached, the object returns to the unrestored state and is stored in its original storage class.

Cumulative Validity Period Rule

If you initiate a restore request for an object at time A and set the validity period to N days, the restore expiration time will be A + N. Later, you make another restore request for the object at time B (B is earlier than A + N) and set the validity period to M days:

If B + M is later than A + N, the expiration time changes to B + M, and the total validity period is (B – A) + M, as shown in Figure 1.

Figure 1 Cumulative validity period rule
Click to enlarge

If B + M is earlier than A + N, the second restore will fail.

Prerequisites

You have the obs:object:RestoreObject permission. For details, see Granting Permissions to an IAM User Under the Current Account.

Ways to Restore Objects

You can use OBS Console, APIs, SDKs, OBS Browser+, or obsutil to restore Archive or Deep Archive objects.

Using OBS Console

In the navigation pane of OBS Console, choose Object Storage.
In the bucket list, click the bucket you want to operate. The Objects page is displayed.
Select the file you want to restore, and click Restore in the Operation column.

You can select multiple files and choose More > Restore above the file list to batch restore them.

Figure 2 Restore Object

Configure the validity period and speed of the restore.

**Table 1** Parameters for restoring objects
Parameter	Description
Validity Period	The number of days that the object will remain in the Restored state. It starts once the object is restored. The value is an integer from 1 to 30 (days). The default value is 30. For example, if you set Validity Period to 20, 20 days after the object is successfully restored, its status will change from Restored to Unrestored.
Speed	The time required for restoring an object. Expedited: Archive objects can be restored within 1 to 5 minutes, and Deep Archive objects can be restored within 3 to 5 hours. Standard: Archive objects can be restored within 3 to 5 hours, and Deep Archive objects can be restored within 5 to 12 hours.

Click OK.

The system checks the file restore status at UTC 00:00 every day. The system starts counting down the expiration time from the time when the latest check is complete.

Using APIs

Restoring Archive or Deep Archive Objects

Using SDKs

Using the GUI Tool - OBS Browser+

Log in to OBS Browser+.
Go to the object list in the target bucket.

Select the file or folder you want to restore and choose More > Restore Object. The window shown in Figure 3 is displayed.

Figure 3 Restoring an object
Click to enlarge

To restore an object, you must configure the validity period and restore speed. Table 2 describes relevant parameters.

**Table 2** Restoring an object
Parameter	Description
Object Name	Name of the object or path to be restored.
Validity Period	Time duration when an object remains in the Restored state after it has been restored. The validity period starts when the object is restored. You can set the validity period to an integer ranging from 1 to 30 (days). The default value is 30. For example, you set Validity Period to 20 when restoring an object. 20 days after the object is restored, its status will change from Restored to Unrestored.
Speed	How fast an object will be restored. Expedited: Data smaller than 250 MB can be restored within 1 to 5 minutes. Standard: All Archive data can be restored within 3 to 5 hours.

Click OK to confirm the restored file or folder.

To view the restoration status of the file or folder, click next to the object and choose Object Properties to view the restoration status. You can download the file only after it has been restored.

Using the CLI Tool - obsutil

Command Line Structure

In Windows

Restoring an object

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

Restoring objects in batches

obsutil restore obs://bucket[/key] -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-token=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] [-e=xxx] [-i=xxx] [-k=xxx] [-token=xxx]

In Linux or macOS

Restoring an object

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

Restoring objects in batches

./obsutil restore obs://bucket[/key] -r [-f] [-v] [-d=1] [-t=xxx] [-o=xxx] [-j=1] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-token=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] [-e=xxx] [-i=xxx] [-k=xxx] [-token=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	The bucket name
key	Mandatory for restoring a single object whose storage class is cold Optional for batch restoring objects whose storage class is cold	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)	The 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)	The 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 and from Deep Archive storage (under limited beta testing) within 3 to 5 hours. standard indicates that objects can be restored from Archive storage within 3 to 5 hours and from Deep Archive storage (under limited beta testing) within 5 to 12 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)	The version ID of the to-be-restored object whose storage class is cold
fs	Optional (additional parameter)	Whether the method of listing parallel file systems is applied. If you are listing parallel file systems, you are recommended to add this parameter. CAUTION: With this method, the listing time required varies largely depending on the directory structures. After this parameter is enabled, marker and limit will be ignored. Then, the size of the bucket, parallel file system, or directory will be calculated. This parameter is only supported by obsutil 5.5.12 and later.
fr	Optional for restoring a single object whose storage class is cold (additional parameter)	Generates an operation result file 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)	The folder that stores the result files. After the command is executed, result files (possibly success and failure files) will be created in the specified folder. The default value is .obsutil_output, a subfolder in the user's home directory where obsutil commands are executed. NOTE: A result file should be named as follows: restore_{succeed \| failed}_report_time_TaskId.txt. By default, the maximum size of a single result file is 30 MB and the maximum number of result files that can be retained is 1,024. 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)	The 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)	The user-defined configuration file for executing the current command. To learn the parameters that can be configured in this file, see Configuration Parameters.
e	Optional (additional parameter)	The endpoint
i	Optional (additional parameter)	The user's AK
k	Optional (additional parameter)	The user's SK
token	Optional (additional parameter)	The user's security token

Response

Field	Description
Parallel	The parameter -p in the request
Jobs	The parameter -j in the request
Threshold	The parameter -threshold in the request
PartSize	The parameter -ps in the request
Exclude	The parameter -exclude in the request
Include	The parameter -include in the request
TimeRange	The parameter -timeRange in the request
VerifyLength	The parameter -vlength in the request
VerifyMd5	The parameter -vmd5 in the request
CheckpointDir	The parameter -cpd in the request
OutputDir	The parameter -o in the request
ArcDir	The parameter -arcDir in the request
Succeed count	The number of successful tasks
Failed count	The number of failed tasks
Skip count	The number of tasks that are skipped during incremental upload, download, or copy, and synchronous upload, download, or copy. NOTE: Skipped tasks are recorded into successful tasks.
Warning count	The number of tasks that are executed successfully but contain warnings. NOTE: The task for which a warning is generated may be a failure or a success, which needs to be further determined according to the corresponding result list. The number of tasks that generate warnings is independent of the number of successful or failed tasks. The total number of tasks is the number of successful tasks plus the number of failed tasks.
Succeed bytes	The number of bytes that are successfully uploaded or downloaded.
max cost	The maximum duration of all tasks, in ms
min cost	The minimum duration of all tasks, in ms
average cost	The average duration of all tasks, in ms
average tps	The average number of tasks completed per second
Task id	The unique ID of an operation, which is used to search for the result file generated for a batch task