すべてのプロダクト
Search

このプロダクト

    Object Storage Service:OSS SDK for PHPを使用したオブジェクトのリスト

    ドキュメントセンター

    Object Storage Service:OSS SDK for PHPを使用したオブジェクトのリスト

    最終更新日:Nov 08, 2024

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

    使用上の注意

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

    • このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (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 {
    // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
    $provider = new EnvironmentVariableCredentialsProvider();
    // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // Specify the name of the bucket. Example: 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 {
    // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
    $provider = new EnvironmentVariableCredentialsProvider();
    // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // Specify the name of the bucket. Example: 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify that up to 200 objects can be listed at a time. 
$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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify that up to 200 objects can be listed at a time. 
$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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the prefix to 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the prefix to 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify the marker parameter. Example: test.txt. Objects whose names are alphabetically after the object specified by the marker parameter are listed. 
$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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify the startAfter parameter. Example: test.txt. Objects whose names are alphabetically after the object specified by the startAfter parameter are listed. 
$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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // Specify that up to 200 objects are listed on each page. 
    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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // Specify that up to 200 objects are listed on each page. 
    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操作を呼び出して、名前にdirプレフィックスが含まれているオブジェクトを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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify that up to 100 objects can be listed on each page. 
$maxKeys = 100;
// Specify the prefix. Example: 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操作を呼び出して、名前にdirプレフィックスが含まれているオブジェクトを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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Specify that up to 100 objects can be listed on each page. 
$maxKeys = 100;
// Specify the prefix. Example: 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');

    特定のエンコーディングタイプを使用して名前がエンコードされているオブジェクトを一覧表示する

    オブジェクトの名前に次のいずれかの文字が含まれている場合、オブジェクトを送信する前にオブジェクト名を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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // Specify that the object names are URL-encoded. 
    OssClient::OSS_ENCODING_TYPE=>'url',
    // Specify that up to 20 objects can be listed on each page. 
    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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
$options = array(
    // Specify that the object names are URL-encoded. 
    OssClient::OSS_ENCODING_TYPE=>'url',
    // Specify that up to 20 objects can be listed on each page. 
    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はフラット構造を使用してオブジェクトを格納します。 ディレクトリは、名前がスラッシュ (/) で終わるゼロバイトのオブジェクトです。 このディレクトリをアップロードおよびダウンロードできます。 デフォルトでは、名前がスラッシュ (/) で終わるオブジェクトは、OSSコンソールにディレクトリとして表示されます。

    デリミタとプレフィックスパラメータを指定して、ディレクトリごとにオブジェクトを一覧表示できます。

    • リクエストでプレフィックスをディレクトリ名に設定すると、プレフィックスを含む名前のオブジェクトとサブディレクトリが一覧表示されます。

    • リクエストでプレフィックスを指定し、区切り文字をスラッシュ (/) に設定すると、ディレクトリ内で指定されたプレフィックスで始まる名前のオブジェクトとサブディレクトリが一覧表示されます。 各サブディレクトリは、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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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");
  }
}

    • レスポンスの例

      上记の2つの操作を呼び出して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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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 lists all subdirectories in the fun/ directory. 
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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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 lists all subdirectories in the fun/ directory. 
if (!empty($prefixList)) {
  print("prefixList: \n");
  foreach ($prefixList as $prefixInfo) {
    print($prefixInfo->getPrefix() . "\n");
  }
}

    • レスポンスの例

      上记の2つの操作を呼び出して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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.  
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
// Set the directory name to 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);

    • レスポンスの例

      上记の操作を呼び出してfun /ディレクトリ内のオブジェクトのサイズを一覧表示すると、次の応答が返されます。 

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

    関連ドキュメント

    • オブジェクトの一覧表示に使用する完全なサンプルコードについては、『GitHub』をご参照ください。

    • オブジェクトを一覧表示するために呼び出すAPI操作の詳細については、「GetBucket (ListObjects) 」および「ListObjectsV2 (GetBucketV2) 」をご参照ください。