全部產品
Search
文件中心

Object Storage Service:要求者付費模式(PHP SDK V2)

更新時間:Aug 05, 2025

要求者付費模式是指由要求者支付讀取儲存空間(Bucket)內資料時產生的流量費用和請求費用,而Bucket擁有者僅支付儲存費用。您可以啟用此功能,適用於需要共用資料且避免承擔額外流量費用和請求費用的情況。

注意事項

  • 本文範例程式碼以華東1(杭州)的地區IDcn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

  • 要佈建要求者付費模式,您必須有oss:PutBucketRequestPayment許可權;要擷取要求者付費模式,您必須有oss:GetBucketRequestPayment許可權。具體操作,請參見為RAM使用者授予自訂的權限原則

範例程式碼

佈建要求者付費模式

您可以使用以下代碼佈建要求者付費模式。

<?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], // 地區是必填項,儲存空間所在的地區,例如 oss-cn-hangzhou。
    "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(); // 載入SDK的預設配置。
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者。
$cfg->setRegion($region); // 設定地區。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱,則設定訪問網域名稱。
}

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

// 建立設定儲存空間請求支付方式的請求對象
$request = new Oss\Models\PutBucketRequestPaymentRequest(
    $bucket,
    new Oss\Models\RequestPaymentConfiguration('Requester') 
);

// 調用putBucketRequestPayment方法設定儲存空間請求支付方式
$result = $client->putBucketRequestPayment($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], // 地區是必填項,儲存空間所在的地區,例如 oss-cn-hangzhou。
    "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(); // 載入SDK的預設配置。
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者。
$cfg->setRegion($region); // 設定地區。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱,則設定訪問網域名稱。
}

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

// 建立擷取儲存空間請求支付方式的請求對象
$request = new Oss\Models\GetBucketRequestPaymentRequest($bucket); 

// 調用getBucketRequestPayment方法擷取儲存空間請求支付方式
$result = $client->getBucketRequestPayment($request); 

// 列印返回結果
printf(

    'status code:' . $result->statusCode . PHP_EOL . // HTTP響應狀態代碼。
    'request id:' . $result->requestId . PHP_EOL . // 請求的唯一標識。
    'request payer:' . $result->requestPaymentConfiguration->payer // 返回的請求支付方式(BucketOwner 或 Requester)。
);

相關文檔

  • 關於佈建要求者付費模式的完整範例程式碼,請參見Github樣本

  • 關於佈建要求者付費模式的API介面說明,請參見PutBucketRequestPayment

  • 關於擷取要求者付費模式配置資訊的完整範例程式碼,請參見Github樣本

  • 關於擷取要求者付費模式配置資訊的API介面,請參見GetBucketRequestPayment