PHP获取存储空间的信息

更新时间:2025-03-21 05:27:48

本文介绍如何通过OSS PHP SDK获取指定存储空间的访问跟踪状态信息、地域、创建日期、读写权限、拥有者的名称和ID、存储类型、数据容灾类型、外网域名、内网域名、跨区域复制状态、版本控制状态、加密方式等内容,以便进行相应操作。

注意事项

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

  • 要获取存储空间的信息,您必须具有oss:GetBucketInfo权限。具体操作,请参见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的域名。
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项。
];
$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"]; // 存储空间所在区域。
$bucket = $options["bucket"]; // 存储空间名称。

// 使用环境变量加载凭证信息(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客户端实例。

// 创建获取存储空间信息的请求对象
$request = new Oss\Models\GetBucketInfoRequest($bucket); // 创建请求对象,用于获取指定存储空间的详细信息。

// 调用getBucketInfo方法获取存储空间信息
$result = $client->getBucketInfo($request); // 调用getBucketInfo方法获取存储空间的详细信息。

// 打印返回结果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码。
    'request id:' . $result->requestId . PHP_EOL . // 请求的唯一标识。
    'bucket info:' . var_export($result->bucketInfo, true) // 存储空间的详细信息。
);

相关文档

  • 本页导读 (1)
  • 注意事项
  • 示例代码
  • 相关文档