このページでは、ラベルの概要と、Resource Manager API と Google Cloud Platform Console を使用してラベルを作成および管理する方法について説明します。
ラベルとは
ラベルとは、Google Cloud Platform インスタンスの整理に役立つ Key-Value ペアです。各リソースにラベルを設定し、そのラベルに基づいてリソースをフィルタリングできます。ラベルに関する情報は課金システムに転送されるため、ラベルを基準に請求料金を分析することもできます。
ラベルの一般的な用途
次に、ラベルの一般な使用例を示します。
チームまたはコストセンターのラベル: 各チームが所有するインスタンスを区別するために、チームやコストセンターに基づいてラベルを追加します（
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 でエンコードする必要があります。国際文字も使用できます。
- ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
- キーは、小文字または国際文字で始める必要があります。
特定のレポーティング サービスとプロジェクトで 1 時間に維持される Key-Value ペアの数は 1,000 個に制限されています。たとえば、Compute Engine サービスは仮想マシン（VM）インスタンスに関する指標を報告します。それぞれにラベルを適用した 2,000 台の VM を使用するプロジェクトをデプロイすると、1 時間に確認された最初の 1,000 個のラベルのサービス レポート指標だけが維持されます。
Resource Manager API でラベルの作成と管理を行う
ラベル付きの新しいプロジェクトを作成するには、プロジェクトを作成するときに label フィールドを設定します。
REST
リクエスト:
POST https://cloudresourcemanager.googleapis.com/v1beta1/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()
...
既存のプロジェクトにラベルを追加するには:
プロジェクトのラベルの更新方法については、プロジェクトの更新をご覧ください。
ラベルを使用してプロジェクトをフィルタリングする方法については、プロジェクトの一覧作成をご覧ください。
GCP Console でラベルの作成と管理を行う
単一のプロジェクトにラベルを追加するには:
- GCP Console で [ラベル] ページを開きます。
[ラベル] ページを開く - [プロジェクトを選択] プルダウンからプロジェクトを選択します。
- 新しいラベルエントリを追加するには、[+ ラベルを追加] をクリックして、追加するラベルのラベルキーと値を入力します。
- ラベルの追加が完了したら、[保存] をクリックします。
同時に複数のプロジェクトにラベルを追加するには:
- GCP Console で [リソースの管理] ページを開きます。
[リソースの管理] ページを開く - [リソースの管理] ページで、ラベルを追加する組織とプロジェクトを選択します。
- 右側のパネルの [ラベル] タブで [+ ラベルを追加] をクリックして、追加するラベルのラベルキーと値を入力します。
- ラベルの追加が完了したら、[保存] をクリックします。
ラベルの追加後、プロジェクト リストの上にあるフィルタ ボックスにラベルキーまたは値を入力すると、プロジェクトをフィルタリングできます。フィルタ ボックスにキーと値が表示され、結果をプレビューできます。
現在ラベルをサポートしているサービス
現在、次の GCP サービスでラベルがサポートされています。
- BigQuery
- Cloud Bigtable
- Cloud Dataflow
- Cloud Dataproc
- Cloud Deployment Manager
- Cloud Functions
- Cloud Key Management Service
- Cloud Pub/Sub
- Cloud Spanner
- Cloud SQL
- Cloud Storage
- Compute Engine
- Google Kubernetes Engine
- ネットワーキング
- Resource Manager
