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