全部產品
Search

搜尋本產品

    Object Storage Service：PHP列舉檔案

    文件中心

    Object Storage Service：PHP列舉檔案

    更新時間：Jun 19, 2024

    本文介紹如何列舉指定儲存空間下（Bucket）的所有檔案（Object）、指定個數的檔案、指定首碼的檔案等。

    注意事項

    • 本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見訪問網域名稱和資料中心。

    • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見建立OssClient。

    • 要列舉檔案，您必須有oss:ListObjects許可權。具體操作，請參見為RAM使用者授權自訂的權限原則。

    簡單列舉檔案

    您可以通過listObjects或者listObjectsV2兩種方法列舉指定Bucket中根目錄下的檔案（不包含目錄及目錄下的檔案）。

    • 通過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以杭州為例，其它Region請按實際情況填寫。
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // 填寫Bucket名稱，例如examplebucket。
    $bucket= "examplebucket";
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,        
    );
    $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以杭州為例，其它Region請按實際情況填寫。
    $endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    // 填寫Bucket名稱，例如examplebucket。
    $bucket= "examplebucket";
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,        
    );
    $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兩種方法列舉指定Bucket下指定個數的檔案。

    • 通過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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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兩種方法列舉某個Bucket下指定首碼的檔案。

    • 通過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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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編碼。

    • 單引號（' '）

    • 雙引號（" "）

    • and符號（&）

    • 角括弧（< >）

    • 頓號（、）

    • 中文

    您可以通過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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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並以正斜線（/）結尾的檔案。這個檔案可以被上傳和下載，控制台會對以正斜線（/）結尾的檔案以檔案夾的方式展示。

    通過delimiter和prefix兩個參數可以類比檔案夾功能：

    • 如果設定prefix為某個檔案夾名稱，則會列舉以此prefix開頭的檔案，即該檔案夾下所有的檔案和子檔案夾（目錄）均顯示為objects。

    • 如果在設定了prefix的情況下，將delimiter設定為正斜線（/），則只列舉該檔案夾下的檔案和子檔案夾（目錄），該檔案夾下的子檔案夾（目錄）顯示為CommonPrefixes，子檔案夾下的檔案和檔案夾不顯示。

    假設儲存空間中包含檔案oss.jpg、fun/test.jpg、fun/movie/001.avi和fun/movie/007.avi，以正斜線（/）作為檔案夾的分隔字元。以下樣本說明了如何通過類比檔案夾的方式列舉檔案。

    列舉Bucket下的所有檔案

    您可以通過listObjects或者listObjectsV2兩種方法列舉指定Bucket下的所有檔案。

    • 通過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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

 $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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以華東1（杭州）為例，其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱，例如examplebucket。
$bucket= "examplebucket";

$config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $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

    相關文檔