Updated on 2026-09-22 GMT+08:00

Performing a File-based Download

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.

This example downloads object objectname from bucket bucketname as localfile.

The 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'
]);

try {
    $resp = $obsClient->getObject([
        'Bucket' => 'bucketname',
        'Key' => 'objectname',
        'SaveAsFile' => 'localfile'
    ]);
    printf( "RequestId:%s\n", $resp['RequestId']);
} catch (ObsException $e) {
    // If the operation fails, obtain the exception details.
    printf("GetObjectFailed: Status:%d, Code:%s, Message:%s\n", $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
    $obsClient->close();
}
  • Use the SaveAsFile parameter to specify the path for saving the to-be-downloaded file.
  • For details about the meanings, causes, and handling methods of error codes that may be returned during the operation, see SDK Error Codes.