Help Center/ Object Storage Service/ User Guide/ Object Management/ Object Management/ Restoring Archive or Deep Archive Objects
Updated on 2024-11-26 GMT+08:00
View PDF
Share

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.

Within the validity period of a restored object, you can restore the object again. The validity period is then extended because it will start again when the latest restore is complete.

If a restored object is restored again, its expiration time should be later than the time set for the previous restore. Assume that an object is restored on January 1 and will expire 30 days later (on January 30). If the object is restored again on January 10 and is made to be expired earlier than January 30 (less than 20 days later), this restore action is considered invalid.

Prerequisites

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

Important Notes

  • If an Archive or a Deep Archive object is being restored, its restore speed cannot be changed and also the restore task cannot be suspended or deleted.
  • 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.
  • During the restore validity period, you will be billed for the space taken up by both the object and its copy. The copy will be automatically deleted once the restore expires.
  • If versioning is enabled and there are different versions of an object in different storage classes, the current version of the object will be restored. To restore a specific object version, you can specify versionId.
  • If you restore an object that is being restored, error 409 will be reported. Wait for the current restore to finish before attempting to restore again.
  • 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.

Object Restore Option and Time Required

OBS provides the following restore options.

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

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.

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

  1. In the navigation pane of OBS Console, choose Object Storage.
  2. In the bucket list, click the bucket you want to operate. The Objects page is displayed.
  3. Select the file you want to restore, and click Restore on the right.

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

    Objects that are being restored cannot be added for batch restore.

    Figure 1 Restore Object

  4. 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.

  5. 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

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

Using the GUI Tool - OBS Browser+

  1. Log in to OBS Browser+.
  2. Go to the object list in the target bucket.
  3. Select the file you want to restore and choose More > Restore Object. The window shown in Figure 2 is displayed.

    Figure 2 Restoring an object

    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 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.

  4. Click OK to confirm the restored file.

    To view the file restore status, 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

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 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)

Version ID of the to-be-restored object whose storage class is cold

fs

Optional (additional parameter)

Specifies 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 buckets or parallel file systems (including directories) 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 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.

e

Optional (additional parameter)

Specifies the endpoint.

i

Optional (additional parameter)

Specifies the user's AK.

k

Optional (additional parameter)

Specifies the user's SK.

token

Optional (additional parameter)

Specifies the user's security token.

Response

Field

Description

Parallel

Parameter -p in the request

Jobs

Parameter -j in the request

Threshold

Parameter -threshold in the request

PartSize

Parameter -ps in the request

Exclude

Parameter -exclude in the request

Include

Parameter -include in the request

TimeRange

Parameter -timeRange in the request

VerifyLength

Parameter -vlength in the request

VerifyMd5

Parameter -vmd5 in the request

CheckpointDir

Parameter -cpd in the request

OutputDir

Parameter -o in the request

ArcDir

Parameter -arcDir in the request

Succeed count

Number of successful tasks

Failed count

Number of failed tasks

Skip count

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

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

Number of bytes that are successfully uploaded or downloaded.

max cost

Maximum duration of all tasks, in ms

min cost

Minimum duration of all tasks, in ms

average cost

Average duration of all tasks, in ms

average tps

The average number of tasks completed per second

Task id

Unique ID of an operation, which is used to search for the result list generated in a batch task
Parent Topic: Object Management