このページでは、Cloud Storage のバケットのラベルを追加、変更、削除、表示する方法について説明します。
必要なロール
バケットラベルを追加して管理するために必要な権限を取得するには、バケットに対するストレージ管理者(roles/storage.admin
)IAM ロールを付与するよう管理者に依頼してください。
この事前定義ロールには、バケットラベルの追加と管理に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。
必要な権限
storage.buckets.get
storage.buckets.list
- この権限は、Google Cloud コンソールを使用してこのページの手順を実施する場合にのみ必要です。
storage.buckets.update
カスタムロールを使用して、これらの権限を取得することもできます。
バケットに対してロールを付与する手順については、バケットで IAM を使用するをご覧ください。
バケットラベルの追加、変更、削除
コンソール
- Google Cloud コンソールで、Cloud Storage の [バケット] ページに移動します。
バケットのリストで、ラベルの追加、変更、削除を行うバケットの名前をクリックします。
[バケットの詳細] ページで、[構成] タブをクリックします。
[ラベル] の編集アイコン(edit)をクリックします。
ラベルエディタ ウィンドウが表示されます。
ラベルを追加するには、[add_box ラベルの追加] ボタンをクリックして、ラベルの
key
とvalue
を指定します。既存のラベルを変更するには、その値をクリックし、新しい値を入力します。
ラベルを削除するには、削除するラベルに対応するゴミ箱アイコンをクリックします。
[保存] をクリックします。
失敗した Cloud Storage オペレーションの詳細なエラー情報を Google Cloud コンソールで確認する方法については、トラブルシューティングをご覧ください。
コマンドライン
新しいラベルを追加するか、既存のラベルを更新するには、--update-labels
フラグを指定して gcloud storage buckets update
コマンドを使用します。次に例を示します。
gcloud storage buckets update gs://BUCKET_NAME --update-labels=KEY_1=VALUE_1
Where
BUCKET_NAME
は、ラベルが適用されるバケットの名前です。例:my-bucket
KEY_1
は、ラベルのキー名です。例:pet
VALUE_1
は、ラベルの値です。例:dog
既存のラベルを削除するには、-remove-labels
フラグを使用します。例:
gcloud storage buckets update gs://BUCKET_NAME --remove-labels=KEY_1
上記のコマンドで複数のラベルを変更するには、関連するフラグにラベルをカンマ区切りリストで指定します。例: --update-labels=blue-key=cyan,red-key=ruby
バケットに適用されているすべてのラベルを削除するには、次のコマンドを使用します。
gcloud storage buckets update gs://BUCKET_NAME --clear-labels
クライアント ライブラリ
C++
詳細については、Cloud Storage C++ API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
C#
詳細については、Cloud Storage C# API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
Go
詳細については、Cloud Storage Go API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
Java
詳細については、Cloud Storage Java API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
Node.js
詳細については、Cloud Storage Node.js API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
PHP
詳細については、Cloud Storage PHP API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
Python
詳細については、Cloud Storage Python API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
Ruby
詳細については、Cloud Storage Ruby API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のサンプルでは、指定されたラベルをバケットに追加します。バケットにすでにラベルがある場合はラベルを変更します。
次のサンプルでは、指定されたラベルをバケットから削除します。
REST API
JSON API
gcloud CLI のインストールと初期化を行います。これにより、
Authorization
ヘッダーのアクセス トークンを生成できます。次の情報が含まれる JSON ファイルを作成します。
{ "labels": { "KEY_1": "VALUE_1" } }
配信先
KEY_1
は、ラベルのキー名です。例:pet
VALUE_1
は、ラベルの値です。例:dog
キーを削除するには、"<var>VALUE_1</var>"
の代わりにnull
を使用します。
cURL
を使用して、PATCH
Bucket リクエストで JSON API を呼び出します。curl -X PATCH --data-binary @JSON_FILE_NAME \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=labels"
ここで
JSON_FILE_NAME
は、手順 2 で作成した JSON ファイルのパスです。BUCKET_NAME
は、ラベルが適用されるバケットの名前です。例:my-bucket
1 つのリクエストで複数の key:value
ペアを追加、編集、削除できます。
XML API
gcloud CLI のインストールと初期化を行います。これにより、
Authorization
ヘッダーのアクセス トークンを生成できます。次の情報が含まれる XML ファイルを作成します。
<Tagging> <TagSet> <Tag> <Key>KEY_1</Key> <Value>VALUE_1</Value> </Tag> </TagSet> </Tagging>
ここで
KEY_1
は、ラベルのキー名です。例:pet
VALUE_1
は、ラベルの値です。例:dog
リクエストには複数の
<Tag>
要素を追加できることに注意してください。バケット上のすべてのラベルを削除するには、ファイル内の単一の空の<Tag>
要素を使用します。<Tagging> <TagSet> <Tag> </Tag> </TagSet> </Tagging>
cURL
を使用して、PUT
Bucket リクエストとtagging
クエリ文字列パラメータを含む XML API を呼び出します。curl -X PUT --data-binary @XML_FILE_NAME \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://storage.googleapis.com/BUCKET_NAME?tagging"
ここで
XML_FILE_NAME
は、手順 2 で作成した XML ファイルのパスです。BUCKET_NAME
は、ラベルが適用されるバケットの名前です。例:my-bucket
バケットラベルを表示する
コンソール
- Google Cloud コンソールで、Cloud Storage の [バケット] ページに移動します。
ラベルを表示するバケットの名前をクリックします。
[構成] タブをクリックします。
バケットに設定されたラベルは、[ラベル] フィールドに表示されます。
失敗した Cloud Storage オペレーションの詳細なエラー情報を Google Cloud コンソールで確認する方法については、トラブルシューティングをご覧ください。
コマンドライン
gcloud storage buckets describe
コマンドを使用し、--format
フラグを指定します。
gcloud storage buckets describe gs://BUCKET_NAME --format="default(labels)"
ここで、BUCKET_NAME
はラベルを表示するバケットの名前です。例: my-bucket
処理に成功し、バケットにラベルが存在する場合、レスポンスは次のようになります。
labels: red-key: ruby blue-key: cyan
処理に成功し、バケットにラベルが存在しない場合、レスポンスは次のようになります。
null
クライアント ライブラリ
C++
詳細については、Cloud Storage C++ API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。C#
詳細については、Cloud Storage C# API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。Go
詳細については、Cloud Storage Go API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。Java
詳細については、Cloud Storage Java API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。Node.js
詳細については、Cloud Storage Node.js API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。PHP
詳細については、Cloud Storage PHP API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。Python
詳細については、Cloud Storage Python API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。Ruby
詳細については、Cloud Storage Ruby API のリファレンス ドキュメントをご覧ください。
Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
バケットのラベルを表示するには、バケットのメタデータを表示する手順に沿って、レスポンス内のラベル フィールドを探します。REST API
JSON API
gcloud CLI のインストールと初期化を行います。これにより、
Authorization
ヘッダーのアクセス トークンを生成できます。cURL
を使用して、fields=labels
クエリ文字列パラメータを含むGET
Bucket リクエストで JSON API を呼び出します。curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=labels"
ここで、
BUCKET_NAME
はラベルを表示するバケットの名前です。例:my-bucket
次の例のようなレスポンスになります。
{ "labels" : { (your_label_key): your_label_value }, }
XML API
gcloud CLI のインストールと初期化を行います。これにより、
Authorization
ヘッダーのアクセス トークンを生成できます。cURL
を使用して、GET
Bucket リクエストとtagging
クエリ文字列パラメータを含む XML API を呼び出します。curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://storage.googleapis.com/BUCKET_NAME?tagging"
ここで、
BUCKET_NAME
はラベルを表示するバケットの名前です。例:my-bucket
次の例のようなレスポンスになります。
<Tagging> <TagSet> <Tag> <Key>your_label_key</Key> <Value>your_label_value</Value> </Tag> </TagSet> </Tagging>
次のステップ
- バケットタグについて学習する。
- 追加のバケット メタデータを取得する。