Object Storage Service：日誌轉存（PHP SDK V2）

以下代碼用於開啟日誌轉存功能。

<?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"]; // 儲存空間名稱

// 使用環境變數載入憑證資訊 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);

// 建立設定儲存空間日誌功能的請求對象
$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               // 請求的唯一標識
);

以下代碼用於查看日誌轉存配置。

<?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"]; // 儲存空間名稱

// 使用環境變數載入憑證資訊 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);

// 建立擷取儲存空間日誌功能的請求對象
$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 .   // 請求的唯一標識
    'logging status:' . var_export($result->bucketLoggingStatus, true) . PHP_EOL // 儲存空間日誌功能的配置狀態
);

以下代碼用於關閉日誌轉存功能。

<?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"]; // 儲存空間名稱

// 使用環境變數載入憑證資訊 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);

// 建立刪除儲存空間日誌功能的請求對象
$request = new Oss\Models\DeleteBucketLoggingRequest(
    bucket: $bucket // 儲存空間名稱
);

// 調用deleteBucketLogging方法刪除儲存空間的日誌功能配置
$result = $client->deleteBucketLogging($request);

// 列印返回結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP響應狀態代碼
    'request id:' . $result->requestId               // 請求的唯一標識
);

您可以使用PutUserDefinedLogFieldsConfig介面為儲存空間（Bucket）即時日誌中的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); // 設定Bucket所在地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 設定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介面擷取儲存空間（Bucket）即時日誌中user_defined_log_fields欄位的個人化配置。

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 定義命令列參數描述（需包含Bucket地區、訪問網域名稱和名稱）
$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); // 解析命令列參數

// 驗證必填參數是否存在（確保region和bucket參數已提供）
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); // 設定Bucket所在地區（如：cn-hangzhou）
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 設定自訂訪問網域名稱（如https://oss-cn-hangzhou.aliyuncs.com）
}

// 建立OSS用戶端執行個體（用於執行API調用）
$client = new Oss\Client($cfg);

// 構建擷取自訂日誌欄位配置請求
$request = new Oss\Models\GetUserDefinedLogFieldsConfigRequest(bucket: $bucket); // 指定要查詢的Bucket名稱

// 執行擷取自訂日誌欄位配置操作（需oss:GetUserDefinedLogFieldsConfig許可權）
$result = $client->getUserDefinedLogFieldsConfig($request); // 調用介面擷取配置資訊

// 輸出操作結果狀態代碼、請求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介面刪除儲存空間（Bucket）即時日誌中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], // 地區參數：儲存空間所在地區
    "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"]; // 擷取地區參數值
$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 // 請求唯一標識
);