全部产品
Search
文档中心

对象存储 OSS:PHP列举存储空间

更新时间:Mar 19, 2025

本文介绍如何列举当前账号所有地域下符合指定条件的存储空间。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名

  • 要列举存储空间,您必须具有oss:ListBuckets权限。具体操作,请参见为RAM用户授权自定义的权限策略

示例代码

列举存储空间

您可以使用以下代码列举当前账号所有地域下的存储空间。

<?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"); // 打印存储空间名称和所在区域。
    }
}

相关文档