このトピックでは、OSS SDK for PHP V2 を使用してバケットレベルで Block Public Access 機能を管理する方法について説明します。このトピックでは、Object Storage Service (OSS) SDK for PHP 2.0 を使用してバケットの Block Public Access を管理する方法について説明します。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョン内の他の Alibaba Cloud サービスからバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
サンプルコード
バケットの Block Public Access を有効にする
次のサンプルコードは、バケットの Block Public Access を有効にする方法の例を示しています。
<?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], // エンドポイントはオプションの引数です。 他のサービスが 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"]; // バケット名。
// AccessKey ID と AccessKey シークレットを含む認証情報を環境変数からロードします。
$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);
// PutBucketPublicAccessBlockRequest オブジェクトをビルドして、バケットの Block Public Access 構成を設定します。
$request = new Oss\Models\PutBucketPublicAccessBlockRequest(
bucket: $bucket,
publicAccessBlockConfiguration: new Oss\Models\PublicAccessBlockConfiguration(blockPublicAccess: true) // パブリックアクセスをブロックするように構成します。
);
// putBucketPublicAccessBlock メソッドを呼び出して、バケットの Block Public Access 構成を設定し、結果を受け入れます。
$result = $client->putBucketPublicAccessBlock($request);
// ステータスコードとリクエスト ID を含む結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL .
'request id:' . $result->requestId
);
指定されたバケットの Block Public Access 構成を取得する
次のサンプルコードは、バケットの Block Public Access 構成を取得する方法の例を示しています。
<?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], // エンドポイントはオプションの引数です。 他のサービスが 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"]; // バケット名。
// AccessKey ID と AccessKey シークレットを含む認証情報を環境変数からロードします。
$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);
// GetBucketPublicAccessBlockRequest オブジェクトをビルドして、バケットの Block Public Access 構成を取得します。
$request = new Oss\Models\GetBucketPublicAccessBlockRequest(bucket: $bucket);
// getBucketPublicAccessBlock メソッドを呼び出して、バケットの Block Public Access 構成を取得し、結果を受け入れます。
$result = $client->getBucketPublicAccessBlock($request);
// ステータスコード、リクエスト ID、および Block Public Access 構成を含む結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL .
'request id:' . $result->requestId . PHP_EOL .
'bucket public access block config:' . var_export($result->publicAccessBlockConfiguration, true)
);
指定されたバケットの Block Public Access 構成を削除する
次のサンプルコードは、指定されたバケットの Block Public Access 構成を削除する方法の例を示しています。
<?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], // エンドポイントはオプションの引数です。 他のサービスが 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"]; // バケット名。
// AccessKey ID と AccessKey シークレットを含む認証情報を環境変数からロードします。
$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);
// DeleteBucketPublicAccessBlockRequest オブジェクトをビルドして、バケットの Block Public Access 構成を削除します。
$request = new Oss\Models\DeleteBucketPublicAccessBlockRequest(bucket: $bucket);
// deleteBucketPublicAccessBlock メソッドを呼び出して、バケットの Block Public Access 構成を削除し、結果を受け入れます。
$result = $client->deleteBucketPublicAccessBlock($request);
// ステータスコードとリクエスト ID を含む結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL .
'request id:' . $result->requestId
);
関連ドキュメント
バケットの Block Public Access を管理する方法を示す完全なサンプルコードについては、Github をご参照ください。
バケットの Block Public Access を有効にするために使用される API 操作の詳細については、「PutBucketPublicAccessBlock」をご参照ください。
バケットの Block Public Access 構成を取得するために使用される API 操作の詳細については、「GetBucketPublicAccessBlock」をご参照ください。
バケットの Block Public Access 構成を削除するために使用される API 操作の詳細については、「DeleteBucketPublicAccessBlock」をご参照ください。