バケットのバージョン管理設定は、バケット内のすべてのオブジェクトに適用されます。バケットのバージョン管理を有効にすると、誤ってオブジェクトを上書きまたは削除した場合でも、バケット内のオブジェクトの以前のバージョンを復元できます。
考慮事項
このトピックのサンプルコードでは、中国 (杭州) リージョン (ID:
cn-hangzhou) を例として使用します。このコードでは、デフォルトでパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud プロダクトから OSS にアクセスする場合は、内部エンドポイントを使用してください。OSS でサポートされているリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。バケットのバージョン管理状態を設定するには、
oss:PutBucketVersioning権限が必要です。バケットのバージョン管理状態を取得するには、oss:GetBucketVersioning権限が必要です。詳細については、「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], // バケットが配置されているリージョン。(必須)
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // エンドポイント。(オプション)
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケット名。(必須)
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後にコロン ":" を追加して、値が必要であることを示します。
$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" . PHP_EOL;
exit(1); // 必須の引数が欠落している場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケット名。
// 環境変数から認証情報を読み込みます。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$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);
// PutBucketVersioningRequest オブジェクトを作成して、バケットのバージョン管理機能を有効にします。
$request = new Oss\Models\PutBucketVersioningRequest(
bucket: $bucket,
versioningConfiguration: new Oss\Models\VersioningConfiguration(
status: 'Enabled' // バージョン管理ステータスを "Enabled" に設定します。
)
);
// バケットのバージョン管理を有効にする操作を実行します。
$result = $client->putBucketVersioning($request);
// バージョン管理を有効にした結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 は成功を示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグや追跡に使用されます。
);
バケットのバージョン管理状態情報の取得
次のコードを使用して、バケットのバージョン管理状態情報を取得できます。
<?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],
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False],
"bucket" => ['help' => 'The name of the bucket', 'required' => True],
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$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" . PHP_EOL;
exit(1); // 必須の引数が欠落している場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"];
$bucket = $options["bucket"];
// 環境変数から認証情報を読み込みます。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$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);
// GetBucketVersioningRequest オブジェクトを作成して、バケットのバージョン管理ステータスを取得します。
$request = new Oss\Models\GetBucketVersioningRequest(
bucket: $bucket
);
// バケットのバージョン管理ステータスを取得する操作を実行します。
$result = $client->getBucketVersioning($request);
// バージョン管理ステータスを取得した結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 は成功を示します。
'request id:' . $result->requestId . PHP_EOL . // リクエスト ID。リクエストのデバッグや追跡に使用されます。
'version status:' . $result->versioningConfiguration->status . PHP_EOL // バージョン管理ステータス (Enabled、Suspended、または空の文字列など)。
);