ラベルの作成と管理

このページでは、ラベルの概要を説明し、Resource Manager API と Google Cloud Console を使用してラベルを作成および管理する方法について説明します。

ラベルとは

ラベルとは、Google Cloud のインスタンスを整理する際に役立つ Key-Value ペアです。各リソースにラベルを設定し、そのラベルに基づいてリソースをフィルタリングできます。ラベルに関する情報は課金システムに転送されるため、ラベルを基準に請求料金を分析することもできます。

ラベルは、リソースに対するクエリ可能なアノテーションとして使用できますが、ポリシーの条件の設定には使用できません。タグを使用すると、リソースに特定のタグが付加されているかどうかに基づいて、条件付きでポリシーの許可や拒否を行えます。詳細については、タグの概要をご覧ください。

ラベルの一般的な用途

タイムスタンプやすべての API 呼び出しに個別に値を作成するなど、一意のラベルを多数作成することはおすすめしません。次に、ラベルの一般的な使用例を示します。

  • チームまたはコストセンターのラベル: チームやコストセンターに基づいてラベルを追加し、各チームが所有するインスタンスを区別します（例: team:research、team:analytics）。この種類のラベルは、費用計算または予算作成に使用できます。

  • コンポーネント ラベル: component:redis、component:frontend、component:ingest、component:dashboard など。

  • 環境ラベルまたはステージのラベル: environment:production、environment:test など。

  • 状態のラベル: state:active、state:readytodelete、state:archive など。

  • 仮想マシンのラベル: 仮想マシンに設定できるラベル。過去に定義した仮想マシンのタグは、値のないラベルとして表示されます。

ラベルの要件

リソースに適用するラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーは、小文字または国際文字で始める必要があります。

これらの上限は、各ラベルのキーと値だけでなく、ラベルのある個々の Google Cloud リソースにも適用されます。1 つのプロジェクト内のすべてのリソースに適用できるラベルの数に制限はありません。

Resource Manager API でラベルの作成と管理を行う

ラベルを持つ新しいプロジェクトを作成するには、プロジェクトの作成時に labels フィールドを設定します。

REST

リクエスト:

POST https://cloudresourcemanager.googleapis.com/v3/projects

{
 "labels": {
  "color": "red"
 },
 "name": "myproject",
 "projectId": "our-project-123"
}
レスポンス: 

{
 "projectNumber": "333197460082",
 "projectId": "our-project-123",
 "lifecycleState": "ACTIVE",
 "name": "myproject",
 "labels": {
  "color": "red"
 },
 "createTime": "2016-01-12T22:18:28.633Z",
}

Python

...

  project = crm.projects().create(
    body={
        'project_id': flags.projectId,
        'name': 'myproject',
        labels.color: "red"
}).execute()

...


既存のプロジェクトにラベルを追加するには:

  • get() メソッドを使用してプロジェクトを取得します。
  • labels フィールドを変更します。
  • patch() メソッドを使用して、プロジェクトを更新します。

プロジェクトのラベルの更新方法については、プロジェクトの更新をご覧ください。

ラベルを使用してプロジェクトをフィルタリングする方法については、プロジェクトの一覧作成をご覧ください。

権限

ラベルを追加または変更するには、projects.patch() メソッドを呼び出します。これには resourcemanager.projects.update 権限が必要です。

プロジェクトのラベルを表示するには、projects.get() メソッドを呼び出します。これには resourcemanager.projects.get 権限が必要です。

Cloud Console を使用してラベルを作成、管理する

単一のプロジェクトにラベルを追加するには:

  1. Cloud Console で [ラベル] ページを開きます。
    [ラベル] ページを開く
  2. [プロジェクトを選択] プルダウンからプロジェクトを選択します。
  3. 新しいラベルエントリを追加するには、[+ ラベルを追加] をクリックして、追加するラベルのラベルキーと値を入力します。
  4. ラベルの追加が完了したら、[保存] をクリックします。

同時に複数のプロジェクトにラベルを追加するには:

  1. Cloud Console で [リソースの管理] ページを開きます。
    [リソースの管理] ページを開く
  2. [リソースの管理] ページで、ラベルの追加先の組織とプロジェクトを選択します。
  3. 右側のパネルの [ラベル] タブで [+ ラベルを追加] をクリックして、追加するラベルのラベルキーと値を入力します。
  4. ラベルの追加が完了したら、[保存] をクリックします。

ラベルの追加後、プロジェクト リストの上にあるフィルタ ボックスにラベルキーまたは値を入力すると、プロジェクトをフィルタリングできます。フィルタ ボックスにキーと値が表示され、結果をプレビューできます。

ラベルをサポートするサービス

現在、次の Google Cloud サービスでラベルがサポートされています。

  • AI Platform
  • App Engine（フレキシブル環境とスタンダード環境の両方）
  • Artifact Registry
  • BigQuery
  • Certificate Authority Service
  • Cloud Bigtable
  • Cloud Composer
  • Cloud Deployment Manager
  • Cloud Functions
  • Cloud Healthcare API
  • Cloud Key Management Service
  • Cloud Run
  • Cloud Spanner
  • Cloud SQL
  • Cloud Storage
  • Cloud Translation
  • Compute Engine
  • Dataflow
  • Dataproc
  • Filestore
  • Google Kubernetes Engine
  • Memorystore
  • ネットワーキング
  • Pub/Sub
  • reCAPTCHA Enterprise
  • Resource Manager（プロジェクトのみ）