すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:PHP 用 OSS SDK を使用したバケットの一覧表示

最終更新日:Mar 27, 2025

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

注意事項

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

  • oss:ListBuckets 権限は、バケットを一覧表示するために必要です。 詳細については、「RAM ユーザーへのカスタムアクセス権限ポリシーの付与」をご参照ください。

サンプルコード

バケットの一覧表示

以下は、現在の Alibaba Cloud アカウント内のすべてのリージョンでバケットを一覧表示するコード例です。

<?php

require_once __DIR__ . '/../vendor/autoload.php'; // 依存ライブラリをロードするためのオートロードファイルをインポートします

use AlibabaCloud\Oss\V2 as Oss;

// コマンドラインパラメータを指定します。
$optsdesc = [
    "region" => ['help' => 'バケットが配置されているリージョン。', 'required' => True], // リージョンは必須です。例:oss-cn-hangzhou。
    "endpoint" => ['help' => '他のサービスが 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"]; // バケットが配置されているリージョン。

// 環境変数を使用して認証情報 (AccessKey ID と AccessKey シークレット) をロードします。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 環境変数から認証情報をロードします。

// SDK のデフォルト設定を使用します。
$cfg = Oss\Config::loadDefault(); // デフォルト設定をロードします。
$cfg->setCredentialsProvider($credentialsProvider); // 認証プロバイダを指定します。
$cfg->setRegion($region); // リージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、それを指定します。
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg); 

// 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"); // バケット名と場所を出力します。
    }
}

関連情報

  • バケットを一覧表示するために使用される完全なサンプルコードについては、GitHub サンプルをご覧ください。

  • バケットを一覧表示するために呼び出すことができる API 操作については、「ListBuckets (GetService)」をご参照ください。