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

Performing a Text-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.

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'
    ]);
    printf( "RequestId:%s\n", $resp['RequestId']);
    printf("Object Content:\n");
    // Obtain the object content.
    echo $resp['Body'];
} 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();
}
  • Text download loads all object content to the memory. For large files (whose size is larger than 100 MB), you are advised to use streaming download (SaveAsStream) or file download (SaveAsFilepath).
  • When this download mode is adopted, Body in the returned result is an instance of GuzzleHttp\Psr7\StreamInterface, which contains text content.
  • For details about the meanings, causes, and handling methods of error codes that may be returned during the operation, see SDK Error Codes.