PHP SDK V2 を使用してバケットを一覧表示する方法 - Object Storage Service

このトピックでは、現在のアカウント内のすべてのリージョンで、指定された条件を満たすバケットを一覧表示する方法について説明します。

注意事項

このトピックのサンプルコードでは、中国 (杭州) リージョン ID cn-hangzhou を例として使用しています。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud プロダクトから OSS にアクセスする場合は、内部エンドポイントを使用します。詳細については、「リージョンとエンドポイント」をご参照ください。
バケットを一覧表示するには、oss:ListBuckets 権限が必要です。詳細については、「RAM ユーザーにカスタムアクセスポリシーを付与する」をご参照ください。
SDK を使用してバケットを一覧表示する場合、リソースグループ ID を指定して、特定のリソースグループ内のバケットをフィルターできます。
- デフォルトでは、SDK を使用してバケットを一覧表示する場合、リクエストにリソースグループ ID パラメーターは含まれず、XML フォーマットの応答にはリソースグループ情報は含まれません。
- リクエストでリソースグループ ID パラメーターを指定すると、OSS はそのリソースグループに属するすべてのバケットを返します。
- リクエストでリソースグループ ID パラメーターを指定しない場合、OSS はリクエスターが所有するすべてのバケットを返します。

現在のアカウント内のすべてのリージョンにあるバケットを一覧表示する

<?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"); // バケット名とそのリージョンを出力します。
    }
}

指定されたリソースグループ内のすべてのバケットを一覧表示する

デフォルトでは、SDK を使用してバケットを一覧表示する場合、リクエストにリソースグループ ID パラメーターは含まれず、XML フォーマットの応答にはリソースグループ情報は含まれません。
リクエストでリソースグループ ID パラメーターを指定すると、OSS はそのリソースグループ内のすべてのバケットを返します。
リクエストでリソースグループ ID パラメーターを指定しない場合、OSS はリクエスターが所有するすべてのバケットを返します。

<?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", // 指定されたリソースグループ内のバケットを一覧表示します。
));


// バケットのページ分割された結果を走査します。

foreach ($iter as $page) { // 各ページのバケットのリストを走査します。
    foreach ($page->buckets ?? [] as $bucket) { // 現在のページの各バケットを走査します。
        print ("Bucket: $bucket->name, $bucket->location\n"); // バケット名とそのリージョンを出力します。
    }
}

Object Storage Service:バケットの一覧表示 (PHP SDK V2)

注意事項

現在のアカウント内のすべてのリージョンにあるバケットを一覧表示する

指定されたリソースグループ内のすべてのバケットを一覧表示する

関連情報