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

Listing Objects

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 lists objects in bucket bucketname. By default, 1,000 objects are listed.

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

try {
      $resp = $obsClient->listObjects([
         'Bucket' => 'bucketname'
      ]);

      printf("RequestId:%s\n", $resp['RequestId']);
      if (isset($resp['Contents'])) {
          foreach ($resp['Contents'] as $index => $content) {
             printf("Contents[$index][Key]:%s\n", $content['Key']);
             printf("Contents[$index][LastModified]:%s\n", $content ['LastModified']);
             printf("Contents[$index][Size]:%s\n", $content ['Size']);
          }
      }
} catch (ObsException $e) {
      // If the operation fails, obtain the exception details.
      printf("ListObjectsFailed: Status:%d, Code:%s, Message:%s\n",
        $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
      // Close ObsClient to release resources.
      $obsClient->close();
}

For more information about listing objects, see Listing Objects.