PHP SDK V2 を使用してバケットの転送アクセラレーションを有効にする方法 - Object Storage Service

転送アクセラレーションは、世界中のユーザーの 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 にアクセスするために使用できるドメイン名。
    "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"]);
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// バケットの転送アクセラレーションを有効にするためのリクエストオブジェクトを作成します。
$request = new Oss\Models\PutBucketTransferAccelerationRequest(
    bucket: $bucket, // バケット名。
    transferAccelerationConfiguration: new Oss\Models\TransferAccelerationConfiguration(
        enabled: true // 転送アクセラレーションを有効にします。
    )
);

// putBucketTransferAcceleration メソッドを呼び出して、バケットの転送アクセラレーションを有効にします。
$result = $client->putBucketTransferAcceleration($request);

// 結果を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 応答の HTTP ステータスコード。
    '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], // エンドポイントはオプションです。他のサービスが 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"]);
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// バケットの転送アクセラレーションステータスをクエリするためのリクエストオブジェクトを作成します。
$request = new Oss\Models\GetBucketTransferAccelerationRequest(
    bucket: $bucket // バケット名。
);

// getBucketTransferAcceleration メソッドを呼び出して、バケットの転送アクセラレーションステータスをクエリします。
$result = $client->getBucketTransferAcceleration($request);

// 結果を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 応答の HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL .   // リクエストの一意の ID。
    'transfer acceleration status:' . var_export($result->transferAccelerationConfiguration->enabled, true) . PHP_EOL // 転送アクセラレーションが有効かどうかを示すステータス。
);

リファレンス

転送アクセラレーションの完全なサンプルコードについては、「put_bucket_transfer_acceleration」および「get_bucket_transfer_acceleration」をご参照ください。
転送アクセラレーションを有効にする API 操作の詳細については、「PutBucketTransferAcceleration」をご参照ください。
転送アクセラレーションステータスをクエリする API 操作の詳細については、「GetBucketTransferAcceleration」をご参照ください。