Updated on 2026-09-22 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

Repeated restorations from the Archive storage class extend the restoration's validity period. Note that you will be billed for each restoration.

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

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an 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. The actual restoration duration varies depending on the storage class and restoration options. The restoration usually takes 3 to 5 hours in standard mode.
sleep(6 * 60);

try {
    $resp = $obsClient->getObject([
        'Bucket' => 'bucketname',
        'Key' => 'objectname'
    ]);
    printf("RequestId:%s\n", $resp['RequestId']);
    printf("Object Content:\n");
    // Obtain the text content.
    echo $resp['Body'];
} catch (ObsException $e) {
    // If the operation fails, obtain the exception details.
    printf("RestoreObjectFailed: Status:%d, Code:%s, Message:%s\n", $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
    $obsClient->close();
}
  • 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.