本文介紹如何列舉當前帳號所有地區下符合指定條件的儲存空間。
注意事項
本文範例程式碼以華東1（杭州）的地區ID
cn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。要列舉儲存空間，您必須具有
oss:ListBuckets許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。使用SDK列舉儲存空間時，可以通過指定資源群組ID來篩選特定資源群組下的Bucket。
使用SDK列舉儲存空間時預設不攜帶資源群組ID參數，返回結果的XML裡也不會攜帶資源群組相關資訊。
如果在請求中攜帶資源群組ID參數，則OSS會返回屬於該資源群組的所有Bucket。
如果在請求中未攜帶資源群組ID參數，則OSS會返回要求者擁有的所有Bucket。
列舉當前帳號所有地區下的儲存空間
<?php
require_once __DIR__ . '/../vendor/autoload.php'; // 引入自動負載檔案，載入依賴庫
use AlibabaCloud\Oss\V2 as Oss;
// 定義命令列參數描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // 地區是必填項，儲存空間所在的地區，例如 oss-cn-hangzhou。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 終端節點是可選項，其他服務可以用來訪問OSS的網域名稱。
];
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令列參數
$options = getopt("", $longopts);
// 檢查必填參數是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示缺少必填參數
exit(1);
}
}
// 擷取命令列參數值
$region = $options["region"]; // 儲存空間所在地區。
// 使用環境變數載入憑證資訊（AccessKeyId 和 AccessKeySecret）
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 從環境變數中載入憑證資訊。
// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault(); // 載入SDK的預設配置。
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者。
$cfg->setRegion($region); // 設定地區。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了終端節點，則設定終端節點。
}
// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg); // 建立OSS用戶端執行個體。
// 建立用於ListBuckets操作的分頁器
$paginator = new Oss\Paginator\ListBucketsPaginator($client); // 建立分頁器，用於列出儲存空間。
$iter = $paginator->iterPage(new Oss\Models\ListBucketsRequest()); // 擷取分頁迭代器。
// 遍曆儲存空間分頁結果
foreach ($iter as $page) { // 遍曆每一頁的儲存空間列表。
foreach ($page->buckets ?? [] as $bucket) { // 遍曆當前頁中的每個儲存空間。
print ("Bucket: $bucket->name, $bucket->location\n"); // 列印儲存空間名稱和所在地區。
}
}
列舉指定資源群組ID下的所有儲存空間
使用SDK列舉儲存空間時預設不攜帶資源群組ID參數，返回結果的XML裡也不會攜帶資源群組相關資訊。
如果在請求參數中指定資源群組ID參數，則OSS會返回屬於該資源群組的所有Bucket。
如果在請求參數中未指定資源群組ID參數，則OSS會返回要求者擁有的所有Bucket。
<?php
require_once __DIR__ . '/../vendor/autoload.php'; // 引入自動負載檔案，載入依賴庫
use AlibabaCloud\Oss\V2 as Oss;
// 定義命令列參數描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // 地區是必填項，儲存空間所在的地區，例如 oss-cn-hangzhou。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 終端節點是可選項，其他服務可以用來訪問OSS的網域名稱。
];
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令列參數
$options = getopt("", $longopts);
// 檢查必填參數是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示缺少必填參數
exit(1);
}
}
// 擷取命令列參數值
$region = $options["region"]; // 儲存空間所在地區。
// 使用環境變數載入憑證資訊（AccessKeyId 和 AccessKeySecret）
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 從環境變數中載入憑證資訊。
// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault(); // 載入SDK的預設配置。
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者。
$cfg->setRegion($region); // 設定地區。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了終端節點，則設定終端節點。
}
// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg); // 建立OSS用戶端執行個體。
// 建立用於ListBuckets操作的分頁器
$paginator = new Oss\Paginator\ListBucketsPaginator($client); // 建立分頁器，用於列出儲存空間。
$iter = $paginator->iterPage(new Oss\Models\ListBucketsRequest(
resourceGroupId: "rg-aekzfalvmw2sxby", // 列出指定資源群組ID下的儲存空間
));
// 遍曆儲存空間分頁結果
foreach ($iter as $page) { // 遍曆每一頁的儲存空間列表。
foreach ($page->buckets ?? [] as $bucket) { // 遍曆當前頁中的每個儲存空間。
print ("Bucket: $bucket->name, $bucket->location\n"); // 列印儲存空間名稱和所在地區。
}
}相關文檔
關於列舉儲存空間的完整範例程式碼，請參見GitHub樣本。
關於列舉儲存空間的API介面說明，請參見ListBuckets（GetService）。