Help Center/ Object Storage Service/ SDK Reference/ PHP/ Object Download/ Performing a File-Based Download
Updated on 2024-12-09 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 example 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'
] );

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

printf("RequestId:%s\n", $resp['RequestId']);
  • Use the SaveAsFile parameter to specify the path for saving the to-be-downloaded file.
  • To handle the error codes possibly returned during the operation, see OBS Server-Side Error Codes.