Obtaining Customized Metadata

Updated on 2025-05-16 GMT+08:00

View PDF

NOTICE:

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.

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. For details, see https://support.huaweicloud.com/eu/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'
]);

printf("RequestId:%s\n", $resp['RequestId']);
printf("Metadata:%s\n", print_r($resp['Metadata'], true));

NOTE:

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.

Parent topic: Object Download

Previous topic: Rewriting Response Headers

Next topic: Downloading an Archive Object

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel