バケットラベルの使用

このページでは、Cloud Storage のバケットに設定されるラベルを追加、表示、編集、削除する方法を説明します。バケットとバケットラベルの概要については、主な用語をご覧ください。

バケットラベルを追加する

Console

1. Google Cloud Platform Console で Cloud Storage ブラウザを開きます。
   Cloud Storage ブラウザを開く

2. バケットリストで、ラベルを適用するバケットを見つけ、「その他のオプション」ボタン（3 つの点が縦に並んだボタン）をクリックします。

3. [ラベルを編集] をクリックします。

4. 表示されたサイドパネルで [+ ラベルを追加] ボタンをクリックします。

5. ラベルに key と value を指定します。

6. [保存] をクリックします。

[ラベルを編集] サイドパネルでは、既存のラベルの値も編集できます。

gsutil

label ch コマンドで -l フラグを使用します。次に例を示します。

gsutil label ch -l [KEY_1]:[VALUE_1] gs://[BUCKET_NAME]/

[KEY_1] はラベルのキー名です。[VALUE_1] はラベルの値です。[BUCKET_NAME] は、ラベルが適用されるバケットの名前です。

• 1 つのコマンドで複数の key:value ペアを追加または編集するには、複数の -l フラグを使用します。

• 既存のすべてのラベルを新しいラベルに置き換えるには、label set コマンドを使用します。

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンス ドキュメントをご覧ください。

は、

ベータ版 です。

これは、Cloud Storage 用 C++ クライアント ライブラリ のベータ版リリースです。 このライブラリは下位互換性のない方法で変更される可能性があり、と は、SLA または非推奨ポリシーの対象ではありません。

google/cloud/storage/examples/storage_bucket_samples.cc

GitHub で表示 フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string bucket_name, std::string label_key,
   std::string label_value) {
  StatusOr<gcs::BucketMetadata> updated_metadata = client.PatchBucket(
      bucket_name,
      gcs::BucketMetadataPatchBuilder().SetLabel(label_key, label_value));

  if (!updated_metadata) {
    throw std::runtime_error(updated_metadata.status().message());
  }

  std::cout << "Successfully set label " << label_key << " to " << label_value
            << " on bucket  " << updated_metadata->name() << ".";
  std::cout << " The bucket labels are now:";
  for (auto const& kv : updated_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

PHP

詳細については、Cloud Storage PHP API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Adds or updates a bucket label.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 * @param string $labelName the name of the label to add.
 * @param string $labelValue the value of the label to add.
 */
function add_bucket_label($bucketName, $labelName, $labelValue)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $newLabels = [$labelName => $labelValue];
    $bucket->update(['labels' => $newLabels]);
    printf('Added label %s (%s) to %s' . PHP_EOL, $labelName, $labelValue, $bucketName);
}

Python

詳細については、Cloud Storage Python API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

def add_bucket_label(bucket_name):
    """Add a label to a bucket."""
    storage_client = storage.Client()
    bucket = storage_client.get_bucket(bucket_name)

    labels = bucket.labels
    labels['example'] = 'label'
    bucket.labels = labels
    bucket.patch()

    print('Updated labels on {}.'.format(bucket.name))
    pprint.pprint(bucket.labels)

Ruby

詳細については、Cloud Storage Ruby API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# project_id  = "Your Google Cloud project ID"
# bucket_name = "Name of your Google Cloud Storage bucket"
# label_key   = "Cloud Storage bucket Label Key"
# label_value = "Cloud Storage bucket Label Value"

require "google/cloud/storage"

storage = Google::Cloud::Storage.new project_id: project_id
bucket  = storage.bucket bucket_name

bucket.update do |bucket|
  bucket.labels[label_key] = label_value
end

puts "Added label #{label_key} with value #{label_value} to #{bucket_name}"

REST API

JSON API

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. 次の情報を含む json ファイルを作成し、[VALUES_IN_BRACKETS] を適切な値と置き換えます。

{
  "labels": {
    "[KEY_1]": "[VALUE_1]"
  }
}

3. cURL を使用して、JSON API を PATCH Bucket リクエストで呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X PATCH --data-binary @[JSON_FILE_NAME].json \
       -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       -H "Content-Type: application/json" \
       "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=labels"

1 つのリクエストで複数の key:value ペアを追加または編集できます。

XML API

注: XML でラベル設定リクエストを行うと、指定したバケットに適用されているすべてのラベルがリクエストのラベルで置換されます。現在バケットに適用されているラベルの中で残しておくラベルがある場合には、そのラベルをリクエストで指定します。

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. 次の情報を含む .xml ファイルを作成し、[VALUES_IN_BRACKETS] を適切な値と置き換えます。

   <Tagging>
     <TagSet>
       <Tag>
         <Key>[KEY_1]</Key>
         <Value>[VALUE_1]</Value>
       </Tag>
     </TagSet>
   </Tagging>

   リクエストに複数の <Tag> 要素を追加できます。

3. cURL を使用して、XML API を PUT Bucket リクエストと tagging クエリ文字列パラメータで呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X PUT --data-binary @[XML_FILE_NAME].xml \
       -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       "https://storage.googleapis.com/[BUCKET_NAME]?tagging"

バケットラベルを表示する

Console

1. Google Cloud Platform Console で Cloud Storage ブラウザを開きます。
   Cloud Storage ブラウザを開く

2. バケットリストで、検証するバケットを探し、そのラベル値を確認します。

   

gsutil

次の gsutil ls コマンドを使用します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

gsutil ls -L -b gs://[BUCKET_NAME]/

次の例のようなレスポンスになります。

gs://[BUCKET_NAME]/ :
  Storage class:         MULTI_REGIONAL
  ...
  ...
  Labels:
    {
      "your_label_key": "your_label_value"
    }
  ...

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンス ドキュメントをご覧ください。

は、

ベータ版 です。

これは、Cloud Storage 用 C++ クライアント ライブラリ のベータ版リリースです。 このライブラリは下位互換性のない方法で変更される可能性があり、と は、SLA または非推奨ポリシーの対象ではありません。

google/cloud/storage/examples/storage_bucket_samples.cc

GitHub で表示 フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string bucket_name) {
  StatusOr<gcs::BucketMetadata> bucket_metadata =
      client.GetBucketMetadata(bucket_name, gcs::Fields("labels"));

  if (!bucket_metadata) {
    throw std::runtime_error(bucket_metadata.status().message());
  }

  if (bucket_metadata->labels().empty()) {
    std::cout << "The bucket " << bucket_name << " has no labels set.\n";
    return;
  }

  std::cout << "The labels for bucket " << bucket_name << " are:";
  for (auto const& kv : bucket_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

PHP

詳細については、Cloud Storage PHP API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Prints a list of a bucket's lables.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 */
function get_bucket_labels($bucketName)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $info = $bucket->info();
    if (isset($info['labels'])) {
        foreach ($info['labels'] as $labelKey => $labelValue) {
            printf('%s: %s' . PHP_EOL, $labelKey, $labelValue);
        }
    }
}

Python

詳細については、Cloud Storage Python API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

def get_bucket_labels(bucket_name):
    """Prints out a bucket's labels."""
    storage_client = storage.Client()
    bucket = storage_client.get_bucket(bucket_name)
    labels = bucket.labels
    pprint.pprint(labels)

Ruby

詳細については、Cloud Storage Ruby API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# project_id  = "Your Google Cloud project ID"
# bucket_name = "Name of your Google Cloud Storage bucket"

require "google/cloud/storage"

storage = Google::Cloud::Storage.new project_id: project_id
bucket  = storage.bucket bucket_name

puts "Labels for #{bucket_name}"
bucket.labels.each do |key, value|
  puts "#{key} = #{value}"
end

REST API

JSON API

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. cURL を使用して、目的の fields を含めた GET Bucket リクエストで JSON API を呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X GET -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=labels"

次の例のようなレスポンスになります。

{
  "labels" : {
     ([YOUR_LABEL_KEY]): [YOUR_LABEL_VALUE]
   },
}

XML API

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. cURL を使用して、tagging クエリ パラメータを含めた GET Bucket リクエストで XML API を呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X GET -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       "https://storage.googleapis.com/[BUCKET_NAME]?tagging"

次の例のようなレスポンスになります。

<Tagging>
  <TagSet>
    <Tag>
      <Key>[YOUR_LABEL_KEY]</Key>
      <Value>[YOUR_LABEL_VALUE]</Value>
    </Tag>
  </TagSet>
</Tagging>

バケットラベルを削除する

Console

1. Google Cloud Platform Console で Cloud Storage ブラウザを開きます。
   Cloud Storage ブラウザを開く

2. バケットリストで、ラベルを削除するバケットを見つけ、「その他のオプション」ボタン（3 つの点が縦に並んだボタン）をクリックします。

3. [ラベルを編集] をクリックします。

4. 削除するラベルの [X] をクリックします。

5. [保存] をクリックします。

gsutil

label ch コマンドで -d フラグを使用します。次に例を示します。

gsutil label ch -d [KEY_1] gs://[BUCKET_NAME]/

[KEY_1] はラベルのキー名、[BUCKET_NAME] はラベルを適用するバケットの名前です。

• 既存のすべてのラベルを新しいラベルに置き換えるには、label set コマンドを使用します。

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンス ドキュメントをご覧ください。

は、

ベータ版 です。

これは、Cloud Storage 用 C++ クライアント ライブラリ のベータ版リリースです。 このライブラリは下位互換性のない方法で変更される可能性があり、と は、SLA または非推奨ポリシーの対象ではありません。

google/cloud/storage/examples/storage_bucket_samples.cc

GitHub で表示 フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string bucket_name, std::string label_key) {
  StatusOr<gcs::BucketMetadata> updated_metadata = client.PatchBucket(
      bucket_name, gcs::BucketMetadataPatchBuilder().ResetLabel(label_key));

  if (!updated_metadata) {
    throw std::runtime_error(updated_metadata.status().message());
  }

  std::cout << "Successfully reset label " << label_key << " on bucket  "
            << updated_metadata->name() << ".";
  if (updated_metadata->labels().empty()) {
    std::cout << " The bucket now has no labels.\n";
    return;
  }
  std::cout << " The bucket labels are now:";
  for (auto const& kv : updated_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

PHP

詳細については、Cloud Storage PHP API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Removes a label from a bucket.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 * @param string $labelName the name of the label to remove.
 */
function remove_bucket_label($bucketName, $labelName)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $labels = [$labelName => null];
    $bucket->update(['labels' => $labels]);
    printf('Removed label %s from %s' . PHP_EOL, $labelName, $bucketName);
}

Python

詳細については、Cloud Storage Python API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

def remove_bucket_label(bucket_name):
    """Remove a label from a bucket."""
    storage_client = storage.Client()
    bucket = storage_client.get_bucket(bucket_name)

    labels = bucket.labels

    if 'example' in labels:
        del labels['example']

    bucket.labels = labels
    bucket.patch()

    print('Updated labels on {}.'.format(bucket.name))
    pprint.pprint(bucket.labels)

Ruby

詳細については、Cloud Storage Ruby API のリファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# project_id  = "Your Google Cloud project ID"
# bucket_name = "Name of your Google Cloud Storage bucket"
# label_key   = "Cloud Storage bucket Label Key"

require "google/cloud/storage"

storage = Google::Cloud::Storage.new project_id: project_id
bucket  = storage.bucket bucket_name

bucket.update do |bucket|
  bucket.labels[label_key] = nil
end

puts "Deleted label #{label_key} from #{bucket_name}"

REST API

JSON API

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. 次の情報を含む json ファイルを作成し、[VALUES_IN_BRACKETS] を適切な値と置き換えます。

{
  "labels": {
    "[KEY_1]": null
  }
}

3. cURL を使用して、JSON API を PATCH Bucket リクエストで呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X PATCH --data-binary @[JSON_FILE_NAME].json \
       -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       -H "Content-Type: application/json" \
       "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=labels"

1 つのリクエストで複数の key:value ペアを削除できます。

XML API

注: XML でラベル設定リクエストを行うと、指定したバケットに適用されているすべてのラベルがリクエストのラベルで置換されます。現在バケットに適用されているラベルの中で残しておくラベルがある場合には、そのラベルをリクエストで指定します。

1. OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
2. 次の情報を含む .xml ファイルを作成し、[VALUES_IN_BRACKETS] を適切な値と置き換えます。

   <Tagging>
     <TagSet>
       <Tag>
       </Tag>
     </TagSet>
   </Tagging>

3. cURL を使用して、XML API を PUT Bucket リクエストと tagging クエリ文字列パラメータで呼び出します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。

   curl -X PUT --data-binary @[XML_FILE_NAME].xml \
       -H "Authorization: Bearer [OAUTH2_TOKEN]" \
       "https://storage.googleapis.com/[BUCKET_NAME]?tagging"

次のステップ

• Cloud Storage の主なコンセプトについて学習する。
• バケットに関する情報を取得する。