Updated on 2026-01-16 GMT+08:00

Obtaining Customized Metadata

After an object is successfully downloaded, its customized data is returned.

This example downloads object objectname from bucketname and returns the custom metadata of the object.

The example code is as follows:

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
// Create an ObsClient instance.
$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.
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint',
      'signature' => 'obs'
] );

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

printf("RequestId:%s\n", $resp['RequestId']);
printf("Metadata:%s\n", print_r($resp['Metadata'], true));
  • If Metadata is left blank, the object has no custom metadata configured.
  • To handle the error codes possibly returned during the operation, see OBS Server-Side Error Codes.