すべてのプロダクト
Search

このプロダクト

    Object Storage Service:オブジェクトのリスト (PHP SDK V1)

    ドキュメントセンター

    Object Storage Service:オブジェクトのリスト (PHP SDK V1)

    最終更新日:Nov 30, 2025

    このトピックでは、Object Storage Service (OSS) バケット内のすべてのオブジェクト、指定された数のオブジェクト、および名前に特定のプレフィックスを含むオブジェクトをリストする方法について説明します。

    注意事項

    • このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

    • このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名またはセキュリティトークンサービス (STS) を使用して OSSClient インスタンスを作成する場合は、「OssClient の作成」をご参照ください。

    • オブジェクトをリストするには、oss:ListObjects 権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。

    オブジェクトのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、指定されたバケットのルートディレクトリにあるオブジェクトをリストできます。サブディレクトリおよびサブディレクトリ内のオブジェクトはリストされません。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケットのルートディレクトリにあるオブジェクトをリストする方法を示しています。サブディレクトリおよびサブディレクトリ内のオブジェクトはリストされません。デフォルトでは、100 個のオブジェクトが返されます。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

try {
    // 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
    $provider = new EnvironmentVariableCredentialsProvider();
    // 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // バケット名を指定します。例：examplebucket。
    $bucket= "examplebucket";
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint, 
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"       
    );
    $ossClient = new OssClient($config);
    $listObjectInfo = $ossClient->listObjects($bucket);
    printf("Bucket Name: %s". "\n",$listObjectInfo->getBucketName());
    printf("Prefix: %s". "\n",$listObjectInfo->getPrefix());
    printf("Marker: %s". "\n",$listObjectInfo->getMarker());
    printf("Next Marker: %s". "\n",$listObjectInfo->getNextMarker());
    printf("Max Keys: %s". "\n",$listObjectInfo->getMaxKeys());
    printf("Delimiter: %s". "\n",$listObjectInfo->getDelimiter());
    printf("Is Truncated: %s". "\n",$listObjectInfo->getIsTruncated());
    $objectList = $listObjectInfo->getObjectList();
    $prefixList = $listObjectInfo->getPrefixList();
    if (!empty($objectList)) {
        print("objectList:\n");
        foreach ($objectList as $objectInfo) {
            printf("Object Name: %s". "\n",$objectInfo->getKey());
            printf("Object Size: %s". "\n",$objectInfo->getSize());
            printf("Object Type: %s". "\n",$objectInfo->getType());
            printf("Object ETag: %s". "\n",$objectInfo->getETag());
            printf("Object Last Modified: %s". "\n",$objectInfo->getLastModified());
            printf("Object Storage Class: %s". "\n",$objectInfo->getStorageClass());

            if ($objectInfo->getRestoreInfo()){
                printf("Restore Info: %s". "\n",$objectInfo->getRestoreInfo() );
            }

            if($objectInfo->getOwner()){
                printf("Owner Id:".$objectInfo->getOwner()->getId() . "\n");
                printf("Owner Name:".$objectInfo->getOwner()->getDisplayName() . "\n");
            }
        }
    }
    if (!empty($prefixList)) {
        print("prefixList: \n");
        foreach ($prefixList as $prefixInfo) {
            printf("Common Prefix:%s\n",$prefixInfo->getPrefix());
        }
    }
} catch (OssException $e) {
    printf($e->getMessage() . "\n");
    return;
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを使用して、examplebucket という名前のバケットのルートディレクトリにあるオブジェクトをリストする方法を示しています。この操作では、サブディレクトリやその中のオブジェクトはリストされません。デフォルトでは、最大 100 個のオブジェクトが返されます。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

try {
    // 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
    $provider = new EnvironmentVariableCredentialsProvider();
    // 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // バケット名を指定します。例：examplebucket。
    $bucket= "examplebucket";
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint, 
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"       
    );
    $ossClient = new OssClient($config);
    $listObjectInfo = $ossClient->listObjectsV2($bucket);
    printf("Bucket Name: %s". "\n",$listObjectInfo->getBucketName());
    printf("Prefix: %s". "\n",$listObjectInfo->getPrefix());
    printf("Next Continuation Token: %s". "\n",$listObjectInfo->getNextContinuationToken());
    printf("Continuation Token: %s". "\n",$listObjectInfo->getContinuationToken());
    printf("Max Keys: %s". "\n",$listObjectInfo->getMaxKeys());
    printf("Key Count: %s". "\n",$listObjectInfo->getKeyCount());
    printf("Delimiter: %s". "\n",$listObjectInfo->getDelimiter());
    printf("Is Truncated: %s". "\n",$listObjectInfo->getIsTruncated());
    printf("Start After: %s". "\n",$listObjectInfo->getStartAfter());
    $objectList = $listObjectInfo->getObjectList(); 
    $prefixList = $listObjectInfo->getPrefixList();
    if (!empty($objectList)) {
        print("objectList:\n");
        foreach ($objectList as $objectInfo) {
            printf("Object Name: %s". "\n",$objectInfo->getKey());
            printf("Object Size: %s". "\n",$objectInfo->getSize());
            printf("Object Type: %s". "\n",$objectInfo->getType());
            printf("Object ETag: %s". "\n",$objectInfo->getETag());
            printf("Object Last Modified: %s". "\n",$objectInfo->getLastModified());
            printf("Object Storage Class: %s". "\n",$objectInfo->getStorageClass());

            if ($objectInfo->getRestoreInfo()){
                printf("Restore Info: %s". "\n",$objectInfo->getRestoreInfo() );
            }

            if($objectInfo->getOwner()){
                printf("Owner Id:".$objectInfo->getOwner()->getId() . "\n");
                printf("Owner Name:".$objectInfo->getOwner()->getDisplayName() . "\n");
            }
        }
    }
    if (!empty($prefixList)) {
        print("prefixList: \n");
        foreach ($prefixList as $prefixInfo) {
            printf("Common Prefix:%s\n",$prefixInfo->getPrefix());
        }
    }
} catch (OssException $e) {
    printf($e->getMessage() . "\n");
    return;
}

    指定した数のオブジェクトのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、バケット内の指定された数のオブジェクトをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内の 200 個のオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// 返されるオブジェクトの最大数を 200 に設定します。
$maxkeys = 200;
$options = array(
  'max-keys' => $maxkeys,
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList(); 
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内の 200 個のオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// 返されるオブジェクトの最大数を 200 に設定します。
$maxkeys = 200;
$options = array(
  'max-keys' => $maxkeys,
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList(); 
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    指定したプレフィックスを持つオブジェクトのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、バケット内の指定されたプレフィックスを持つオブジェクトをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内のプレフィックスが dir のオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// プレフィックスを dir/ に設定します。
$prefix = 'dir/';
$options = array(
  'prefix' => $prefix,
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内のプレフィックスが dir のオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// プレフィックスを dir/ に設定します。
$prefix = 'dir/';
$options = array(
  'prefix' => $prefix,
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    指定したオブジェクト名以降のオブジェクトをアルファベット順にリスト

    listObjects または listObjectsV2 メソッドを呼び出して、指定したオブジェクト名の後にアルファベット順で並ぶオブジェクトをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内の test.txt の後にアルファベット順で並ぶオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// marker を test.txt に設定します。このパラメーターは、marker で指定されたオブジェクトからアルファベット順でオブジェクトが返されることを指定します。
$marker = "test.txt";
$options = array(
  OssClient::OSS_MARKER=>$marker
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList(); 
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内の test.txt の後にアルファベット順で並ぶオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// startAfter を test.txt に設定します。このパラメーターは、startAfter で指定されたオブジェクトからアルファベット順でオブジェクトが返されることを指定します。
$startAfter = "test.txt";
$options = array(
  OssClient::OSS_START_AFTER=>$startAfter
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket, $options);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
    return;
}

$objectList = $listObjectInfo->getObjectList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
      print($objectInfo->getKey() . "\n");
  }
}

    すべてのオブジェクトをページ単位でリスト

    listObjects または listObjectsV2 メソッドを呼び出して、すべてのオブジェクトをページ分割方式でリストできます。maxKeys パラメーターを使用して、各ページで返されるオブジェクトの数を指定します。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内のすべてのオブジェクトをページ分割方式でリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // 各ページで返されるオブジェクトの数を 200 に設定します。
    OssClient::OSS_MAX_KEYS=>200
);
do{
    $result = $ossClient->listObjects($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }
    $options[OssClient::OSS_MARKER] = $result->getNextMarker();
}while($result->getIsTruncated() === 'true');

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内のすべてのオブジェクトをページ分割方式でリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // 各ページで返されるオブジェクトの数を 200 に設定します。
    OssClient::OSS_MAX_KEYS=>200
);
do{
    $result = $ossClient->listObjectsV2($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }
    $options[OssClient::OSS_CONTINUATION_TOKEN] = $result->getNextContinuationToken();
}while($result->getIsTruncated() === 'true');

    指定したプレフィックスを持つオブジェクトをページ単位でリスト

    listObjects または listObjectsV2 メソッドを呼び出して、指定したプレフィックスを持つオブジェクトをページ分割方式でリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内のプレフィックスが dir のオブジェクトをページ分割方式でリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// 各ページで返されるオブジェクトの数を 100 に設定します。
$maxKeys = 100;
// プレフィックスを指定します。例：dir/。
$prefix = 'dir/';
$options = array(
    OssClient::OSS_MAX_KEYS =>$maxKeys,
    OssClient::OSS_PREFIX =>$prefix
);
do{
    $result = $ossClient->listObjects($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }
    $options[OssClient::OSS_MARKER] = $result->getNextMarker();
}while($result->getIsTruncated() === 'true');

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内のプレフィックスが dir のオブジェクトをページ分割方式でリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// 各ページで返されるオブジェクトの数を 100 に設定します。
$maxKeys = 100;
// プレフィックスを指定します。例：dir/。
$prefix = 'dir/';
$options = array(
    OssClient::OSS_MAX_KEYS =>$maxKeys,
    OssClient::OSS_PREFIX =>$prefix
);
do{
    $result = $ossClient->listObjectsV2($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }
    $options[OssClient::OSS_CONTINUATION_TOKEN] = $result->getNextContinuationToken();
}while($result->getIsTruncated() === 'true');

    オブジェクト名のエンコーディングの指定

    オブジェクト名に特殊文字が含まれている場合は、転送のためにオブジェクト名をエンコードする必要があります。OSS は URL エンコーディングのみをサポートしています。

    • 単一引用符 (')

    • 二重引用符 (")

    • アンパサンド (&)

    • 山括弧 (< >)

    • 読点 (、)

    • 漢字

    listObjects または listObjectsV2 メソッドを呼び出して、オブジェクト名のエンコーディングを指定できます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出してオブジェクト名のエンコーディングを指定する方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // オブジェクト名のエンコーディングタイプを URL に設定します。
    OssClient::OSS_ENCODING_TYPE=>'url',
    // 各ページで返されるオブジェクトの数を 20 に設定します。
    OssClient::OSS_MAX_KEYS=>20
);
do{
    $result = $ossClient->listObjects($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }

    print("prefix:\n");
    $prefixList = $result->getPrefixList();
    foreach ($prefixList as $prefixInfo) {
        print($prefixInfo->getPrefix() . "\n");
    }

    if($result->getDelimiter() != null){
        printf("delimiter:".$result->getDelimiter().PHP_EOL);
    }

    if($result->getMarker() != null){
        printf("marker:".$result->getMarker().PHP_EOL);
    }

     $options[OssClient::OSS_MARKER] = $result->getNextMarker();
}while($result->getIsTruncated() === 'true');

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出してオブジェクト名のエンコーディングを指定する方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // オブジェクト名のエンコーディングタイプを URL に設定します。
    OssClient::OSS_ENCODING_TYPE=>'url',
    // 各ページで返されるオブジェクトの数を 20 に設定します。
    OssClient::OSS_MAX_KEYS=>20
);
do{
    $result = $ossClient->listObjectsV2($bucket,$options);
    $objectList = $result->getObjectList();
    print("objectList:\n");
    foreach ($objectList as $objectInfo) {
        print($objectInfo->getKey() . "\n");
    }

    print("prefix:\n");
    $prefixList = $result->getPrefixList();
    foreach ($prefixList as $prefixInfo) {
        print($prefixInfo->getPrefix() . "\n");
    }

    if($result->getDelimiter() != null){
        printf("delimiter:".$result->getDelimiter().PHP_EOL);
    }

    if($result->getStartAfter() != null){
        printf("start after:".$result->getStartAfter().PHP_EOL);
    }

    $options[OssClient::OSS_CONTINUATION_TOKEN] = $result->getNextContinuationToken();
}while($result->getIsTruncated() === 'true');

    ディレクトリのシミュレーション

    OSS は、すべてのデータがオブジェクトとして保存されるフラット構造を使用します。ディレクトリをシミュレートするには、名前がスラッシュ (/) で終わる 0 バイトのオブジェクトを作成します。このオブジェクトはアップロードおよびダウンロードできます。OSS コンソールでは、名前がスラッシュ (/) で終わるオブジェクトがディレクトリとして表示されます。

    delimiter および prefix パラメーターを使用して、ディレクトリ機能をシミュレートできます：

    • prefix パラメーターをフォルダ名に設定すると、このプレフィックスで始まる名前のオブジェクトがリストされます。これにより、フォルダ内のすべてのオブジェクトとサブディレクトリが再帰的にリストされます。

    • prefix パラメーターを設定し、delimiter パラメーターをスラッシュ (/) に設定すると、フォルダの最上位レベルのオブジェクトとサブディレクトリのみがリストされます。サブディレクトリは CommonPrefixes 要素で返され、それらのサブディレクトリ内のオブジェクトとフォルダはリストされません。

    バケットにオブジェクト oss.jpg、fun/test.jpg、fun/movie/001.avi、および fun/movie/007.avi が含まれており、フォルダの区切り文字がスラッシュ (/) であると仮定します。次の例は、ディレクトリをシミュレートしてオブジェクトをリストする方法を示しています。

    バケット内のすべてのオブジェクトのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、指定されたバケット内のすべてのオブジェクトをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して、examplebucket という名前のバケット内のすべてのオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
  'delimiter' => '',
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket,$options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して、examplebucket という名前のバケット内のすべてのオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
  'delimiter' => '',
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket,$options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • 応答

      上記のメソッドを呼び出して examplebucket バケット内のすべてのオブジェクトをリストすると、次の応答が返されます。

      objectList:
fun/movie/001.avi
fun/movie/007.avi
fun/test.jpg
oss.jpg

    指定したディレクトリ内のすべてのオブジェクトのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、fun/ ディレクトリ内のすべてのオブジェクトをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して fun/ ディレクトリ内のすべてのオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// ディレクトリを fun/ に設定します。
$prefix = 'fun/';
$options = array(
  'prefix' => $prefix,
  'delimiter' => '',
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket, $options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して fun/ ディレクトリ内のすべてのオブジェクトをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// ディレクトリ名を fun/ に設定します。
$prefix = 'fun/';
$options = array(
  'prefix' => $prefix,
  'delimiter' => '',
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket, $options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • 結果

      上記のメソッドを呼び出して fun/ ディレクトリ内のすべてのオブジェクトをリストすると、次の応答が返されます。

      objectList:
fun/movie/001.avi
fun/movie/007.avi
fun/test.jpg

    ディレクトリ内のオブジェクトとサブディレクトリのリスト

    listObjects または listObjectsV2 メソッドを呼び出して、fun/ ディレクトリ内のオブジェクトとサブディレクトリをリストできます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して fun/ ディレクトリ内のオブジェクトとサブディレクトリをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// ディレクトリ名を fun/ に設定します。
$prefix = 'fun/';
$delimiter = '/'; 
$options = array(
  'delimiter' => $delimiter,
  'prefix' => $prefix,
);
try {
  $listObjectInfo = $ossClient->listObjects($bucket, $options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
// commonPrefixs リストには、fun/ ディレクトリ内のすべてのサブディレクトリが含まれます。
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して fun/ ディレクトリ内のオブジェクトとサブディレクトリをリストする方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"     
    );
    $ossClient = new OssClient($config);
// ディレクトリ名を fun/ に設定します。
$prefix = 'fun/';
$delimiter = '/';
$options = array(
  'delimiter' => $delimiter,
  'prefix' => $prefix,
);
try {
  $listObjectInfo = $ossClient->listObjectsV2($bucket, $options);
} catch (OssException $e) {
  printf(__FUNCTION__ . ": FAILED\n");
  printf($e->getMessage() . "\n");
  return;
}
print(__FUNCTION__ . ": OK" . "\n");
$objectList = $listObjectInfo->getObjectList();
$prefixList = $listObjectInfo->getPrefixList();
if (!empty($objectList)) {
  print("objectList:\n");
  foreach ($objectList as $objectInfo) {
    print($objectInfo->getKey() . "\n");
  }
}
// commonPrefixs リストには、fun/ ディレクトリ内のすべてのサブディレクトリが含まれます。
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • 戻り値

      上記のメソッドを呼び出して fun/ ディレクトリ内のオブジェクトとサブディレクトリをリストすると、次の応答が返されます。

      objectList:
fun/test.jpg
prefixList:
fun/movie/

    指定したディレクトリ内のオブジェクトのサイズの取得

    listObjects または listObjectsV2 メソッドを呼び出して、fun/ ディレクトリ内のオブジェクトのサイズを取得できます。

    • listObjects メソッドの使用

      次のコードは、listObjects メソッドを呼び出して fun/ ディレクトリ内のオブジェクトのサイズを取得する方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// ディレクトリ名を fun/ に設定します。
$prefix = 'fun/';
$delimiter = '';
$nextMarker = '';
$maxkeys = 1000;
$options = array(
    'delimiter' => $delimiter,
    'prefix' => $prefix,
    'max-keys' => $maxkeys,
    'marker' => $nextMarker,
);
$bool = true;
$size = 0;
while ($bool){
    $result = $ossClient->listObjects($bucket,$options);
    foreach ($result->getObjectList() as $objInfo){
        printf("object name".$objInfo->getKey().":" . ($objInfo->getSize() / 1024) . "KB".PHP_EOL);
        $size+=$objInfo->getSize();
    }
    if($result->getIsTruncated() === 'true'){
        $options['marker'] = $result->getNextMarker();
    }else{
        $bool = false;
    }
}
printf($prefix.":" . ($size / 1024) . "KB".PHP_EOL);

    • listObjectsV2 メソッドの使用

      次のコードは、listObjectsV2 メソッドを呼び出して fun/ ディレクトリ内のオブジェクトのサイズを取得する方法を示しています。

      <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}
require_once __DIR__ . '/Common.php';
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// 次の例では、中国 (杭州) リージョンのエンドポイントを使用します。エンドポイントを実際のエンドポイントに置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケット名を指定します。例：examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// ディレクトリ名を fun/ に設定します。
$prefix = 'fun/';
$delimiter = '';
$nextMarker = '';
$maxkeys = 1000;
$options = array(
    'delimiter' => $delimiter,
    'prefix' => $prefix,
    'max-keys' => $maxkeys,
);
$bool = true;
$size = 0;
while ($bool){
    $result = $ossClient->listObjectsV2($bucket,$options);
    foreach ($result->getObjectList() as $objInfo){
        printf("object name".$objInfo->getKey().":" . ($objInfo->getSize() / 1024) . "KB".PHP_EOL);
        $size+=$objInfo->getSize();
    }
    if($result->getIsTruncated() === 'true'){
        $options[OssClient::OSS_CONTINUATION_TOKEN] = $result->getNextContinuationToken();
    }else{
        $bool = false;
    }
}
printf($prefix.":" . ($size / 1024) . "KB".PHP_EOL);

    • 戻り値

      上記のメソッドを呼び出してオブジェクトのサイズを取得すると、次の応答が返されます。

      object namefun/movie/001.avi:0.01953125KB
object namefun/movie/007.avi:290.71875KB
object namefun/test.jpg:144.216796875KB
fun/:434.955078125KB

    関連ドキュメント