PHP获取存储空间的存储容量

本文介绍如何获取指定存储空间(Bucket)的存储容量以及Bucket内不同存储类型文件(Object)的数量及其存储容量。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS访问域名、数据中心、开放端口

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见新建OssClient

  • 要获取存储空间的存储容量,您必须有oss:GetBucketStat权限。具体操作,请参见RAM用户授权自定义的权限策略

示例代码

以下代码用于获取examplebucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量。

重要

PHP SDK 2.6.0及以上版本支持返回以下示例代码中包含的所有属性。

<?php
  if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
  }
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
  require_once __DIR__ . '/../vendor/autoload.php';
}
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填写Bucket名称。
$bucket= "examplebucket";
try {
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
  $ossClient = new OssClient($config);
  $stat = $ossClient->getBucketStat($bucket);
} catch (OssException $e) {
  printf($e->getMessage() . "\n");
  return;
}

// 获取Bucket的总存储量,单位为字节。
printf("Bucket ".$bucket." current storage is:".$stat->getStorage().PHP_EOL);
// 获取Bucket中总的Object数量。
printf("Bucket ".$bucket." object count is:".$stat->getObjectCount().PHP_EOL);
// 获取Bucket中已经初始化但还未完成(Complete)或者还未中止(Abort)的Multipart Upload数量。
printf("Bucket ".$bucket." multipart upload count is:".$stat->getMultipartUploadCount().PHP_EOL);
// 获取Bucket中Live Channel的数量。
printf("Bucket ".$bucket." live channel count is:".$stat->getLiveChannelCount().PHP_EOL);
// 此次调用获取到的存储信息的时间点,格式为时间戳,单位为秒。
printf("Bucket ".$bucket." last modified time is:".$stat->getLastModifiedTime().PHP_EOL);
// 获取标准存储类型Object的存储量,单位为字节。
printf("Bucket ".$bucket." standard storage is:".$stat->getStandardStorage().PHP_EOL);
// 获取标准存储类型的Object的数量。
printf("Bucket ".$bucket." standard object count is:".$stat->getStandardObjectCount().PHP_EOL);
// 获取低频访问类型Object的计费存储量,单位为字节。
printf("Bucket ".$bucket." infrequent access storage is:".$stat->getInfrequentAccessStorage().PHP_EOL);
// 获取低频访问类型Object的实际存储量,单位为字节。
printf("Bucket ".$bucket." infrequent access real storage is:".$stat->getInfrequentAccessRealStorage().PHP_EOL);
// 获取低频访问类型的Object数量。
printf("Bucket ".$bucket." infrequent access object count is:".$stat->getInfrequentAccessObjectCount().PHP_EOL);
// 获取归档存储类型Object的计费存储量,单位为字节。
printf("Bucket ".$bucket." archive storage is:".$stat->getArchiveStorage().PHP_EOL);
// 获取归档存储类型Object的实际存储量,单位为字节。
printf("Bucket ".$bucket." archive real storage is:".$stat->getArchiveRealStorage().PHP_EOL);
// 获取归档存储类型的Object数量。
printf("Bucket ".$bucket." archive object count is:".$stat->getArchiveObjectCount().PHP_EOL);
// 获取冷归档存储类型Object的计费存储量,单位为字节。
printf("Bucket ".$bucket." cold archive storage is:".$stat->getColdArchiveStorage().PHP_EOL);
// 获取冷归档存储类型Object的实际存储量,单位为字节。
printf("Bucket ".$bucket." cold archive real storage is:".$stat->getColdArchiveRealStorage().PHP_EOL);
// 获取冷归档存储类型的Object数量。
printf("Bucket ".$bucket." cold archive object count is:".$stat->getColdArchiveObjectCount().PHP_EOL);

相关文档

关于获取指定Bucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量的API接口说明,请参见GetBucketStat