Help Center/ Object Storage Service/ API Reference/ APIs/ Operations on Objects/ Restoring Archive or Deep Archive Objects
Updated on 2024-09-29 GMT+08:00

Restoring Archive or Deep Archive Objects

Functions

To obtain the content of an object in the Archive or Deep Archive storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of the object is saved in the Standard storage class. By doing so, the object in the Archive or Deep Archive storage class and its copy in the Standard storage class co-exist in the bucket. The copy will be automatically deleted once its retention period ends.

Versioning

By default, this operation returns the latest version of an object. If the object has a delete marker, status code 404 is returned. To restore an object of a specified version, the versionId parameter can be used to specify the desired version.

Request Syntax

POST /ObjectName?restore&versionId=VersionID HTTP/1.1 
Host: bucketname.obs.region.myhuaweicloud.com 
Date: date
Authorization: authorization string
Content-MD5: MD5

<RestoreRequest> 
   <Days>NumberOfDays</Days> 
   <RestoreJob> 
       <Tier>RetrievalOption</Tier> 
   </RestoreJob> 
</RestoreRequest>

Request Parameters

Parameter

Type

Mandatory (Yes/No)

Description

versionId

String

No

Explanation:

Version ID of the Archive or Deep Archive object to be restored

Restrictions:

None

Value range:

None

Default value:

None. If this parameter is not configured, the latest version of the object is specified.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

Table 1 Request elements

Element

Type

Mandatory (Yes/No)

Description

RestoreRequest

Container

Yes

Explanation:

Container for the restore information

Restrictions:

None

Value range:

None

Default value:

None

Days

Integer

Yes

Explanation:

After an object is restored, a Standard copy of it is generated. This parameter specifies how long the Standard copy can be retained, that is, the validity period of the restored object.

Restrictions:

None

Value range:

The value ranges from 1 to 30, in days.

Default value:

None

RestoreJob

Container

No

Explanation:

Container for the restore options

Restrictions:

None

Value range:

None

Default value:

None

Tier

String

No

Explanation:

Retrieval speed tier. You can select a tier that suits your retrieval needs.

NOTE:

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 and data volume restored.

Value range:

  • Expedited indicates that objects can be quickly restored from Archive storage within 1 to 5 minutes and from Deep Archive storage (in a beta test) 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 (in a beta test) within 5 to 12 hours.

Default value:

Standard

Response Syntax

1
2
HTTP/1.1 status_code
Date: date

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains no elements.

Error Responses

Table 2 List of OBS access error codes

Error Code

Description

HTTP Status Code

RestoreAlreadyInProgress

Explanation:

The object is being restored. The request conflicts with another.

ErrorMessage: Object restore is already in progress

409 Conflict

ObjectHasAlreadyRestored

Explanation:

The objects have been restored and the retention period of the objects cannot be shortened.

ErrorMessage: After restoring an archived object, you cannot shorten the restoration period of the archived object

409 Conflict

MalformedXML

Explanation:

Invalid value for the Days field (supposed to be an integer)

ErrorMessage: The XML you provided was not well-formed or did not validate against our published schema

400 Bad Request

InvalidArgument

Explanation:

Invalid value for the Days field (valid range: 1 to 30).

ErrorMessage: restoration days should be at least 1 and at most 30

400 Bad Request

MalformedXML

Explanation:

Invalid value for the Tier field.

ErrorMessage: The XML you provided was not well-formed or did not validate against our published schema

400 Bad Request

InvalidObjectState

Explanation:

The restored object is not in the Archive or Deep Archive storage.

ErrorMessage: Restore is not allowed, as object's storage class is not COLD or DEEP_ARCHIVE

403 Forbidden

Sample Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
POST /object?restore HTTP/1.1
Host: examplebucket.obs.region.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 04:39:46 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:kaEwOixnSVuS6If3Q0Lnd6kxm5A=
Content-Length: 183

<RestoreRequest>
   <Days>2</Days> 
   <RestoreJob>
     <Tier>Expedited</Tier>
   </RestoreJob> 
</RestoreRequest> 

Sample Response

1
2
3
4
5
6
HTTP/1.1 202 Accepted
Server: OBS
x-obs-request-id: A2F500000163F374CCBB2063F834C6C4
x-obs-id-2: 32AAAUgAIAABAAAQAAEAABAAAQAAEAABCSLbWIs23RR95NVpkbWlJdlm8Dq+wQBw
Date: WED, 01 Jul 2015 04:39:46 GMT
Content-Length: 0