このトピックでは、特定の Object Storage Service (OSS) バケットのストレージ使用量と、バケット内のさまざまなストレージタイプのオブジェクトの数とストレージ使用量を照会する方法について説明します。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用しています。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョン内の他の Alibaba Cloud サービスを使用してバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。 OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
例
次のサンプルコードは、バケットのストレージ使用量を照会する方法の例を示しています。
<?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 にアクセスするために使用できるエンドポイントを指定します。
"bucket" => ['help' => 'バケットの名前', '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"]; // バケットの名前。
// 環境変数を使用して資格情報 (AccessKey ID と AccessKey シークレット) をロードします。
$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"]); // エンドポイントが提供されている場合は、エンドポイントを指定します。
}
// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg); // OSSClient インスタンスを作成します。
// バケットの統計情報を取得するリクエストを作成します。
$request=new Oss\Models\GetBucketStatRequest($bucket); // バケットの統計情報を取得するリクエストを作成します。
// getBucketStat メソッドを使用して、バケットの統計情報を取得します。
$result = $client->getBucketStat($request); // getBucketStat メソッドを使用して、バケットの統計情報を取得します。
// 返された結果を出力します。
printf(
'status code:' . $result-> statusCode. PHP_EOL . // HTTP 応答ステータスコード。
'request id:' . $result-> requestId. PHP_EOL . // リクエストの一意の識別子。
'result:' . var_export($result, true) // 返された結果。バケットの統計情報が含まれています。
);
関連情報
バケットに関する情報を照会するために使用される完全なサンプルコードについては、GitHub をご覧ください。
詳細については、「GetBucketStat」をご参照ください。