全部產品
Search
文件中心

Object Storage Service:儲存空間標籤(PHP SDK V2)

更新時間:Aug 05, 2025

本文介紹如何對儲存空間(Bucket)設定標籤。

注意事項

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

範例程式碼

設定Bucket標籤

您可以使用以下代碼為bucket設定標籤。

<?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);

// 建立儲存空間標籤對象 包含多個索引值對
$tagging = new Oss\Models\Tagging(
    tagSet: new Oss\Models\TagSet(
        tags: [new Oss\Models\Tag(key: 'key1', value: 'value1'), new Oss\Models\Tag(key: 'key2', value: 'value2')]
    )
);

// 建立設定儲存空間標籤的請求對象 並將標籤內容傳入
$request = new Oss\Models\PutBucketTagsRequest(bucket: $bucket, tagging: $tagging);

// 調用putBucketTags方法設定儲存空間的標籤
$result = $client->putBucketTags($request);

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

查看Bucket標籤

您可以使用以下代碼查看bucket的標籤資訊。

<?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); // 建立OSS用戶端執行個體

// 建立擷取儲存空間標籤的請求對象
$request = new Oss\Models\GetBucketTagsRequest(bucket: $bucket); // 建立請求對象,用於擷取指定儲存空間的標籤資訊

// 調用getBucketTags方法擷取儲存空間標籤
$result = $client->getBucketTags($request); // 調用getBucketTags方法擷取儲存空間的標籤資訊

// 列印返回結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP響應狀態代碼
    'request id:' . $result->requestId . PHP_EOL . // 請求的唯一標識
    'tags:' . var_export($result->tagging, true) // 返回的標籤資訊,以數組形式展示
);

刪除Bucket所有標籤

<?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); // 建立OSS用戶端執行個體。

// 建立刪除儲存空間標籤的請求對象
$request = new Oss\Models\DeleteBucketTagsRequest(bucket: $bucket); 

// 調用deleteBucketTags方法刪除儲存空間標籤
$result = $client->deleteBucketTags($request); 

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

相關文檔

  • 關於設定Bucket標籤的API介面說明,請參見PutBucketTags

  • 關於擷取Bucket標籤的API介面說明,請參見GetBucketTags

  • 關於刪除Bucket標籤的API介面說明,請參見DeleteBucketTags