Help Center/ Object Storage Service/ SDK Reference/ PHP/ Bucket APIs/ Parallel File Systems/ Listing Objects in a Parallel File System
Updated on 2026-09-22 GMT+08:00

Listing Objects in a Parallel File System

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.

You can call ObsClient->listObjects to list folders and objects in a specified POSIX parallel file system.

<?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;
// 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'),
    // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    'endpoint' => "obs.ap-southeast-1.myhuaweicloud.com",
    'signature' => 'obs'
]);

$bucketName = 'posix-bucket-name';
// List objects in a parallel file system (using pagination).
$isTruncated = true;
$marker = null;
while ($isTruncated) {
       try {
              $resp = $obsClient->listObjects([                  'Bucket' => $bucketName,
                  // Set the folder delimiter.
                  'Delimiter' => '/',
                  'Marker' => $marker,
                  // Specify the maximum number of objects returned on each page. The default value is 1000.
                  'MaxKeys' => 100
              ]);              if (!empty($resp['CommonPrefixes'])) {
                     printf("Folders:\n");
                     foreach ($resp['CommonPrefixes'] as $prefix) {
                            printf("  [D] %s\n", $prefix['Prefix']);
                     }
              }
              if (!empty($resp['Contents'])) {
                     printf("Files:\n");
                     foreach ($resp['Contents'] as $content) {
                            printf("  [F] %s (size: %d bytes)\n", $content['Key'], $content['Size']);
                     }
              }
              $isTruncated = $resp['IsTruncated'];
              $marker = $resp['NextMarker'];
       } catch (\Obs\ObsException $e) {
              printf("ListObjectsFailed: Status:%d, Message:%s\n", $e->getStatusCode(), $e->getExceptionMessage());
              break;
       }
}

// Close the ObsClient instance to release connection resources.
$obsClient->close();