OSS のオブジェクトタグ付けを使用して、バケット内のオブジェクトを分類できます。このトピックでは、OSS SDK for PHP 2.0 を使用してオブジェクトタグを設定する方法について説明します。
注意
このトピックのサンプルコードでは、中国 (杭州) リージョン (
cn-hangzhou) を例として使用します。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS でサポートされているリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。オブジェクトタグを設定するには、
oss:PutObjectTagging権限が必要です。詳細については、「RAM ユーザーにカスタム権限を付与する」をご参照ください。
サンプルコード
説明
バケットでバージョン管理が有効になっている場合、オブジェクトのバージョン ID を指定することで、バケット内のオブジェクトの特定のバージョンにタグを追加したり、タグを変更したりできます。
バージョン 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], // エンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
"key" => ['help' => 'The name of the object', 'required' => True], // オブジェクトの名前。このパラメーターは必須です。
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$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" . PHP_EOL;
exit(1); // 必須の引数が指定されていない場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
$key = $options["key"]; // オブジェクトの名前。
// 環境変数から認証情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から AccessKey ID と AccessKey シークレットを読み取ります。
$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);
// PutObjectTaggingRequest オブジェクトを作成して、オブジェクトのタグ情報を設定します。
$request = new Oss\Models\PutObjectTaggingRequest(
bucket: $bucket,
key: $key,
versionId:"yourVersionId", // 実際のバージョン ID を指定します。
tagging: new Oss\Models\Tagging(
tagSet: new Oss\Models\TagSet(
tags: [
new Oss\Models\Tag('k1', 'v1'), // タグのキーと値のペア: k1=v1。
new Oss\Models\Tag('k2', 'v2') // タグのキーと値のペア: k2=v2。
]
)
)
);
// オブジェクトタグを設定する操作を実行します。
$result = $client->putObjectTagging($request);
// オブジェクトタグの設定結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグや追跡に使用されます。
);