Object Storage Service:ログストレージ (PHP SDK V2)

次のコードは、ログストレージ機能を有効にする方法の例を示しています。

<?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"]);
}

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

// バケットのログストレージ機能を構成するためのリクエストオブジェクトを作成します。
$request = new Oss\Models\PutBucketLoggingRequest(
    bucket: $bucket, // バケットの名前。
    bucketLoggingStatus: new Oss\Models\BucketLoggingStatus(
        loggingEnabled: new Oss\Models\LoggingEnabled(
            targetBucket: $bucket, // ログストレージの宛先バケット。
            targetPrefix: 'log/'   // ログファイルのプレフィックス。
        )
    )
);

// putBucketLogging メソッドを呼び出して、バケットのログストレージ機能を構成します。
$result = $client->putBucketLogging($request);

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

次のコードは、ログストレージ構成を表示する方法の例を示しています。

<?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"]);
}

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

// バケットのログストレージ構成を取得するためのリクエストオブジェクトを作成します。
$request = new Oss\Models\GetBucketLoggingRequest(
    bucket: $bucket // バケットの名前。
);

// getBucketLogging メソッドを呼び出して、バケットのログストレージ構成を取得します。
$result = $client->getBucketLogging($request);

// 返された結果を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP 応答ステータスコード。
    'request id:' . $result->requestId . PHP_EOL .   // 一意のリクエスト ID。
    'logging status:' . var_export($result->bucketLoggingStatus, true) . PHP_EOL // バケットのログストレージ機能の構成ステータス。
);

次のコードは、ログストレージ機能を無効にする方法の例を示しています。

<?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"]);
}

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

// バケットのログストレージ構成を削除するためのリクエストオブジェクトを作成します。
$request = new Oss\Models\DeleteBucketLoggingRequest(
    bucket: $bucket // バケットの名前。
);

// deleteBucketLogging メソッドを呼び出して、バケットのログストレージ構成を削除します。
$result = $client->deleteBucketLogging($request);

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

PutUserDefinedLogFieldsConfig 操作を呼び出して、バケットのリアルタイムログの user_defined_log_fields フィールドを構成できます。これにより、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 ペアをロードします。事前に OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET 環境変数を構成する必要があります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// OSS クライアントのパラメーターを構成します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 認証情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // エンドポイントを設定します。例: https://oss-cn-hangzhou.aliyuncs.com。
}

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

// ユーザー定義ログフィールドを構成するためのリクエストを作成します。
$request = new Oss\Models\PutUserDefinedLogFieldsConfigRequest(
    bucket: $bucket, 
    userDefinedLogFieldsConfiguration: new Oss\Models\UserDefinedLogFieldsConfiguration(
        new Oss\Models\LoggingParamSet(parameters: ['param1', 'params2']), // カスタムログパラメーター。
        new Oss\Models\LoggingHeaderSet(headers: ['header1', 'header2']) // カスタムログヘッダー。
    )
);

// ユーザー定義ログフィールドを構成する操作を実行します。
$result = $client->putUserDefinedLogFieldsConfig($request);

// 操作結果のステータスコードとリクエスト ID を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL .
    'request id:' . $result->requestId
);

GetUserDefinedLogFieldsConfig 操作を呼び出して、バケットのリアルタイムログにある user_defined_log_fields フィールドのカスタム構成を取得できます。

<?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], // リージョンは必須です。バケットが配置されているリージョンを指定します。例: cn-hangzhou。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // エンドポイントはオプションです。エンドポイントは https://oss-<region>.aliyuncs.com 形式である必要があります。
    "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"]; // region パラメーターの値を取得します。
$bucket = $options["bucket"]; // バケット名を取得します。

// 環境変数から AccessKey ペアをロードします。事前に OSS_ACCESS_KEY_ID と OSS_ACCESS_KEY_SECRET 環境変数を構成する必要があります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 環境変数認証情報プロバイダーを使用します。

// リージョン、認証情報、オプションのエンドポイントなど、OSS クライアントのパラメーターを構成します。
$cfg = Oss\Config::loadDefault(); // デフォルトの構成をロードします。
$cfg->setCredentialsProvider($credentialsProvider); // 認証情報プロバイダーをアタッチします。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。例: cn-hangzhou。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // カスタムエンドポイントを設定します。例: https://oss-cn-hangzhou.aliyuncs.com。
}

// API 操作を呼び出すための OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// ユーザー定義ログフィールドの構成を取得するためのリクエストを作成します。
$request = new Oss\Models\GetUserDefinedLogFieldsConfigRequest(bucket: $bucket); // クエリするバケットの名前を指定します。

// ユーザー定義ログフィールドの構成を取得する操作を実行します。oss:GetUserDefinedLogFieldsConfig 権限が必要です。
$result = $client->getUserDefinedLogFieldsConfig($request); // API 操作を呼び出して構成情報を取得します。

// 操作結果のステータスコード、リクエスト ID、構成詳細を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL .
    'request id:' . $result->requestId . PHP_EOL .
    'user defined log fields config:' . var_export($result->userDefinedLogFieldsConfiguration, true) // var_export を使用して構成オブジェクトの構造を出力します。
);

DeleteUserDefinedLogFieldsConfig 操作を呼び出して、バケットのリアルタイムログにある user_defined_log_fields フィールドのカスタム構成を削除できます。

<?php

require_once __DIR__ . '/../vendor/autoload.php'; // SDK の依存関係をロードします。
use AlibabaCloud\Oss\V2 as Oss; // OSS PHP SDK の名前空間をインポートします。

$optsdesc = [ // コマンドライン引数のルールを定義します。
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // region パラメーター: バケットが配置されているリージョン。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // オプションのエンドポイントパラメーター。
    "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"]; // region パラメーターの値を取得します。
$bucket = $options["bucket"]; // バケット名を取得します。

// 環境変数から AccessKey ペアをロードします。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 環境変数の認証情報を使用します。

// クライアント構成を初期化します。
$cfg = Oss\Config::loadDefault(); // デフォルトの構成テンプレートをロードします。
$cfg->setCredentialsProvider($credentialsProvider); // 認証情報プロバイダーをアタッチします。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // カスタムエンドポイントを設定します (オプション)。
}

$client = new Oss\Client($cfg); // OSS クライアントインスタンスを作成します。
$request = new Oss\Models\DeleteUserDefinedLogFieldsConfigRequest(bucket: $bucket); // 構成を削除するリクエストを作成します。
$result = $client->deleteUserDefinedLogFieldsConfig($request); // 削除操作を実行します。

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