Help Center> Object Storage Service> PHP> Object Download> Downloading an Archive Object
Updated on 2023-11-09 GMT+08:00

Downloading an Archive Object

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see API Reference.

Before you can download an Archive object, you must restore it. Archive objects can be restored in either of the following ways.

Option

Description

Value on the OBS Server

Expedited restore

Data can be restored within 1 to 5 minutes.

ObsClient::RestoreTierExpedited

Standard restore

Data can be restored within 3 to 5 hours. This is the default option.

ObsClient::RestoreTierStandard

To prolong the validity period of the Archive data restored, you can repeatedly restore the Archive data, but you will be billed for each restore. After a second restore, the validity period of Standard object copies will be prolonged, and you need to pay for storing these copies during the prolonged period.

You can call ObsClient->restoreObject to restore an Archive object. Sample code is as follows:

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during source code installation.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
// Create an instance of ObsClient.
$obsClient = new ObsClient ( [ 
      //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
      //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint',
      'signature' => 'obs'
] );

// Restore an object in the Archive storage class.
$resp = $obsClient -> restoreObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname',
       'Days' => 1,
       'Tier' => ObsClient::RestoreTierExpedited
]);

printf("RequestId:%s\n", $resp['RequestId']);

// Wait for the object to be restored.
sleep(6 * 60);

$resp = $obsClient -> getObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname'
]);

printf("RequestId:%s\n", $resp['RequestId']);
printf("Object Content:\n");
// Obtain the object content.
echo $resp ['Body'];
  • The object specified in ObsClient->restoreObject must be in the OBS Archive storage class. Otherwise, an error will be reported when you call this API.
  • Use the Days parameter to specify the retention period (from 1 to 30 days) of the restored objects and the Tier parameter to specify the time spent on restoring the objects.