Object Storage Service:静的 Web サイトホスティング (PHP SDK V2)

次のサンプルコードは、静的 Web サイトホスティングを構成する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);

// PutBucketWebsiteRequest オブジェクトを作成して、バケットの静的 Web サイトホスティングを設定します。
$request = new Oss\Models\PutBucketWebsiteRequest(bucket: $bucket,
    websiteConfiguration: new Oss\Models\WebsiteConfiguration(
        indexDocument: new Oss\Models\IndexDocument(
            suffix: 'index.html', // デフォルトのホームページとして使用されるファイルの名前を指定します。
            supportSubDir: true, // バケットのサブディレクトリホームページ機能を有効にします。
            type: 0 // インデックスページのタイプ。
        ),
        errorDocument: new Oss\Models\ErrorDocument(
            key: 'error.html', // デフォルトの 404 ページとして使用されるファイルの名前。
            httpStatus: 404 // デフォルトの 404 ページで返される HTTP ステータスコード。
        )
    )
);

// putBucketWebsite メソッドを使用して、バケットの静的 Web サイトホスティングを設定します。
$result = $client->putBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId // リクエストのリクエスト ID。リクエストの一意の識別子です。
);

次のサンプルコードは、バケットの静的 Web サイトホスティング構成を照会する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);

// GetBucketWebsiteRequest オブジェクトを作成して、バケットの静的 Web サイトホスティング設定をクエリします。
$request = new Oss\Models\GetBucketWebsiteRequest(bucket: $bucket);

// getBucketWebsite メソッドを使用して、バケットの静的 Web サイトホスティング設定をクエリします。
$result = $client->getBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL . // リクエストのリクエスト ID。リクエストの一意の識別子です。
    'website config:' . var_export($result->websiteConfiguration, true) . PHP_EOL // 静的 Web サイトホスティング設定。
);

次のサンプルコードは、バケットの静的 Web サイトホスティング構成を削除する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);

// DeleteBucketWebsiteRequest オブジェクトを作成して、バケットの静的 Web サイトホスティング設定を削除します。
$request = new Oss\Models\DeleteBucketWebsiteRequest(bucket: $bucket);

// deleteBucketWebsite メソッドを使用して、バケットの静的 Web サイトホスティング設定を削除します。
$result = $client->deleteBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId // リクエストのリクエスト ID。リクエストの一意の識別子です。
);

リクエスターが指定されたバケット内のオブジェクトにアクセスしようとして、オブジェクトが存在しない場合、オリジンとオリジン復帰条件でオブジェクトの URL を指定して、リクエスターがオリジンからオブジェクトを取得できるようにすることができます。たとえば、examplebucket という名前のバケットが中国 (杭州) リージョンにあるとします。リクエスターがバケットのルートディレクトリの examplefolder ディレクトリにあるオブジェクトにアクセスしようとして、オブジェクトが存在しない場合、リクエスターは www.example.com にリダイレクトされ、オリジンの examplefolder ディレクトリに保存されているオブジェクトにアクセスします。

次のサンプルコードは、前述のシナリオでミラーリングベースのオリジン復帰ルールを構成する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);

// ミラーリングベースのオリジンフェッチルールを指定します。
$ruleOk = new Oss\Models\RoutingRule(
    ruleNumber: 1, // ルール番号。
    condition: new Oss\Models\RoutingRuleCondition(
        keyPrefixEquals: 'myobject', // 取得したいオブジェクトの名前に含まれるプレフィックスを指定します。
        httpErrorCodeReturnedEquals: 404 // back-to-origin 条件を HTTP ステータスコード 404 に設定します。
    ),
    redirect: new Oss\Models\RoutingRuleRedirect(
        redirectType: 'Mirror', // リダイレクトタイプを Mirror に設定します。
        mirrorURL: 'http://www.test.com/', // ソース URL を指定します。
        mirrorHeaders: new Oss\Models\MirrorHeaders(
            passAll: false, // すべての HTTP ヘッダーを送信するかどうかを指定します。
            passs: ['myheader-key1', 'myheader-key2'], // 送信できる HTTP ヘッダーを指定します。
            removes: ['myheader-key3', 'myheader-key4'], // 送信できない HTTP ヘッダーを指定します。
            sets: [
                new Oss\Models\MirrorHeadersSet(
                    key: 'myheader-key5', // 指定された HTTP ヘッダーの名前を指定します。
                    value: 'myheader-value' // 指定された HTTP ヘッダーの値を指定します。
                ),
            ]
        )
    )
);

// PutBucketWebsite リクエストを作成します。
$request = new Oss\Models\PutBucketWebsiteRequest(
    bucket: $bucketName, // バケットの名前。
    websiteConfiguration: new Oss\Models\WebsiteConfiguration(
        indexDocument: new Oss\Models\IndexDocument(
            suffix: 'index.html', // ミラーリングベースのオリジンフェッチリクエストのデフォルトのホームページ。
            supportSubDir: true,
            type: 0
        ),
        errorDocument: new Oss\Models\ErrorDocument(
            key: 'error.html', // ミラーリングベースのオリジンフェッチリクエストのデフォルトの 404 ページ。
            httpStatus: 404
        ),
        routingRules: new Oss\Models\RoutingRules(
            routingRules: [$ruleOk] // ミラーリングベースのオリジンフェッチルール。
        )
    )
);

// PutBucketWebsite リクエストを実行します。
$result = $client->putBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL . // リクエストのリクエスト ID。リクエストの一意の識別子です。
    'website config:' . var_export($result->websiteConfiguration, true) . PHP_EOL // 静的 Web サイトホスティング設定。
);

次のサンプルコードは、バケットのミラーリングベースのオリジン復帰ルールを照会する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);

// GetBucketWebsite リクエストを作成します。
$request = new Oss\Models\GetBucketWebsiteRequest(
    bucket: $bucketName, // バケットの名前。
);

// GetBucketWebsite リクエストを実行します。
$result = $client->getBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL . // リクエストのリクエスト ID。リクエストの一意の識別子です。
    'website config:' . var_export($result->websiteConfiguration, true) . PHP_EOL // 静的 Web サイトホスティング設定。
);

次のサンプルコードは、バケットのミラーリングベースのオリジン復帰ルールを削除する方法の例を示しています。

<?php

// 依存ライブラリをロードするために autoload ファイルを導入します。
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 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"]);
}

// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);


// DeleteBucketWebsite リクエストを作成します。
$request = new Oss\Models\DeleteBucketWebsiteRequest(
    bucket: $bucketName, // バケットの名前。
);

// deleteBucketWebsite メソッドを使用して、バケットの静的 Web サイトホスティング設定を削除します。
$result = $client->deleteBucketWebsite($request);

// 返された結果を表示します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 返された HTTP ステータスコード。
    'request id:' . $result->requestId // リクエストのリクエスト ID。リクエストの一意の識別子です。
);