事前定義されたメタデータキー

各メタデータ エントリは、Key-Value ペアとしてメタデータ サーバーに保存されます。メタデータキーでは大文字と小文字が区別されます。キーは、事前定義されたメタデータキーまたはカスタム メタデータキーのいずれかにすることができます。

事前定義されたメタデータキーは、Compute Engine によって作成されるメタデータキーです。VM を作成すると、Compute Engine がその VM の一部のキーのメタデータ値（VM インスタンス ID やプロジェクト ID など）を自動的に設定します。Compute Engine が値を自動的に設定しない事前定義キーについては、システム構成に応じて使用可能な値のセットから選択できます。 たとえば、VM の OS Login を有効にするために、その VM の事前定義キー enable-oslogin の値を TRUE に設定できます。この VM の OS Login を無効にするには、キーの値を FALSE に更新します。更新できるのはこれらのキーの値のみで、キー自体は更新できません。

このドキュメントでは、Compute Engine が instance/ メタデータ ディレクトリと project/ メタデータ ディレクトリに提供する事前定義されたメタデータキーについて説明します。

Compute Engine の VM メタデータを定義、分類、配置する方法については、VM メタデータについてをご覧ください。

事前定義されたプロジェクト メタデータキー

プロジェクト メタデータの事前定義されたメタデータキーは、次のディレクトリに保存されます。

  • http://metadata.google.internal/computeMetadata/v1/project/

次の表に、Compute Engine が project/ メタデータ ディレクトリに自動的に作成するメタデータキーとディレクトリの一覧を示します。

メタデータ エントリ 説明
attributes/

起動やシャットダウンのときに、プロジェクトの VM に渡されるカスタム メタデータ値のディレクトリ。これらのカスタム値は、Google Cloud 属性またはユーザーが作成したメタデータ値のいずれかです。

ユーザーが設定できるプロジェクト レベルの Google Cloud 属性の一覧については、プロジェクト属性をご覧ください。

カスタム メタデータの設定の詳細については、カスタム メタデータの設定をご覧ください。
numeric-project-id インスタンスの数値プロジェクト ID（プロジェクト番号）。これは、Google Cloud コンソールに表示されるプロジェクト名と同じではありません。この値は、project-id メタデータ エントリの値とも異なります。
project-id プロジェクト ID。

事前定義されたプロジェクト属性のメタデータキー

プロジェクト属性の事前定義されたメタデータキーは、次のディレクトリに保存されます。

  • http://metadata.google.internal/computeMetadata/v1/project/attributes/

次の表に、Compute Engine が project/attributes/ メタデータ ディレクトリに自動的に作成するメタデータキーの一覧を示します。

メタデータ エントリ 説明
disable-legacy-endpoints

プロジェクト内のすべての VM の、以前のメタデータ サーバー エンドポイントを無効にします。

以前のエンドポイントは非推奨です。常に disable-legacy-endpoints=TRUE を設定します。
enable-guest-attributes

プロジェクトのゲスト属性を設定します。

ゲスト属性は、めったに発生しないステータス通知、少量のデータ、または使用頻度の低いデータを公開する場合に使用できるカスタム VM インスタンスのメタデータ値です。これらの値は、起動スクリプトの終了を通知する場合に便利です。また、他のアプリケーションに頻度の低いステータス通知を提供する場合にも役立ちます。

ゲスト属性の詳細については、ゲスト属性の設定とクエリをご覧ください。
enable-os-inventory

プロジェクトの OS インベントリを有効または無効にします。

OS 情報を収集して保存します。これには、ホスト名、カーネル バージョン、アーキテクチャ、インストール済みパッケージなどの情報が含まれます。

OS インベントリの詳細については、オペレーティング システムの詳細を表示するをご覧ください。
enable-oslogin

プロジェクトで SSH 認証鍵の管理を有効または無効にします。

OS Login の詳細については、OS Login を設定するをご覧ください。
enable-windows-ssh

Windows VM の SSH を有効または無効にします。

詳細については、SSH を使用して Windows VM に接続するをご覧ください。
google-compute-default-region 設定されている場合、プロジェクトで使用されるデフォルトのリージョンを保存します。

デフォルト リージョンの設定の詳細については、デフォルトのリージョンとゾーンをご覧ください。
google-compute-default-zone 設定されている場合、プロジェクトで使用されるデフォルトのゾーンを保存します。

デフォルト ゾーンの設定の詳細については、デフォルトのリージョンとゾーンをご覧ください。
ssh-keys

メタデータを使用して SSH 認証鍵を管理する場合、この属性によって、プロジェクト内の VM に接続できる公開 SSH 認証鍵を構成できます。複数の SSH 認証鍵がある場合は、改行文字（\n）で区切ります。ssh-keys 属性の値は文字列です。

例: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

OS Login が管理する SSH 認証鍵は、メタデータには表示されません。
sshKeys 非推奨: ssh-keys を使用します。
vmdnssetting

プロジェクト内の VM に対してゾーン DNS とグローバル DNS を有効にします。

VM にゾーン DNS 名を使用する方法の詳細については、内部 DNS タイプにゾーン DNS を使用するをご覧ください。

事前定義されたインスタンス メタデータキー

インスタンス メタデータの事前定義されたメタデータキーは、次のディレクトリに保存されます。

  • http://metadata.google.internal/computeMetadata/v1/instance/

次の表に、Compute Engine が instance/ メタデータ ディレクトリに自動的に作成するメタデータキーとディレクトリの一覧を示します。

メタデータ エントリ 説明
attributes/

起動やシャットダウンのときに、VM に渡されるカスタム メタデータ値のディレクトリ。これらのカスタム値は、Google Cloud 属性またはユーザーが作成したメタデータ値のいずれかです。

ユーザーが設定できるインスタンス レベルの Google Cloud 属性の一覧については、インスタンス属性をご覧ください。

カスタム メタデータの設定の詳細については、カスタム メタデータを設定するをご覧ください。
cpu-platform

VM の CPU プラットフォーム。

CPU プラットフォームについては、CPU プラットフォームをご覧ください。
description Google Cloud CLI または API で --description フラグを使用して割り当てられたインスタンスの説明。
disks/

VM にアタッチされているディスクのディレクトリ。ディスクごとに次の情報を利用できます。

  • device-name
  • index
  • interface
  • mode
  • type

ディスクの詳細については、ストレージ オプションをご覧ください。
gce-workload-certificates/（プレビュー）

VM で実行中のアプリケーションで使用される、マネージド ワークロード ID 機能の次のエンドポイントを格納します。

  • config-status: VM メタデータを介して指定された構成値にエラーがあるエンドポイント。
  • workload-identities: Compute Engine コントロール プレーンで管理される ID を含むエンドポイント。このエンドポイントには、X.509 証明書と VM の信頼ドメインの秘密鍵が含まれています。
  • trust-anchors: ピア X.509 証明書チェーン検証に使用する信頼された証明書のセットを含むエンドポイント。

詳細については、mTLS を使用してワークロード間で認証を行うをご覧ください。
guest-attributes/

VM のゲスト属性を設定します。これらのカスタム値は、Google Cloud 属性またはユーザーが作成したメタデータ値のいずれかです。

ユーザーが設定できるインスタンス レベルの Google Cloud 属性の一覧については、インスタンスのゲスト属性をご覧ください。

ゲスト属性の詳細については、ゲスト属性の設定とクエリをご覧ください。
hostname VM のホスト名。
id VM の ID。Compute Engine によって生成される一意の数値 ID です。VM 名を使用していない場合に VM を識別するために利用できます。
image VM が使用するオペレーティング システム イメージ。値は、projects/IMAGE_PROJECT/global/images/IMAGE_NAME の形式です。
legacy-endpoint-access/ 以前のエンドポイントのリストを保存します。値は 0.1 および v1beta1 です。
licenses/ イメージ、スナップショット、ディスクにライセンスを関連付けるために使用されるライセンス コード ID のリスト。
machine-type この VM のマシンタイプ。値は、projects/PROJECT_NUM/machineTypes/MACHINE_TYPE の形式です。
maintenance-event メンテナンス イベントがこの VM に影響を与えているかどうかを示します。詳しくは、ライブ マイグレーションをご覧ください。
name VM の名前。
network-interfaces/

ネットワーク インターフェースのディレクトリ。ネットワーク インターフェースごとに、次の情報を利用できます。

  • access-configs/

    • external-ip
    • type
  • dns-servers
  • forwarded-ips/
  • gateway
  • ip
  • ip-aliases/
  • mac
  • mtu
  • network
  • subnetmask
  • target-instance-ips

ネットワーク インターフェースの詳細については、複数のネットワーク インターフェースの概要をご覧ください。
partner-attributes/（プレビュー）

メタデータ エントリが保存される名前空間を格納するディレクトリ。これらの名前空間は、パートナー属性を使用して構成を保存する Google Cloud サービスによって作成されます。パートナー属性を使用しているサービスがない場合、このディレクトリは空になります。

たとえば、マネージド ワークロード ID の構成にはパートナー属性が使用されます。
preempted

VM がプリエンプトされるかどうかを示すブール値。
scheduling/

VM のスケジューリング オプションを設定します。

スケジューリングのメタデータ値には、次のものがあります。

  • on-host-maintenance: ホスト メンテナンス中に VM を終了するか、ライブ マイグレーションを行うかを示します。
  • automatic-restart: この値が TRUE の場合、メンテナンス イベントまたはクラッシュ後に VM は自動的に再起動します。
  • preemptible: この値が TRUE の場合、インスタンスはプリエンプティブルです。この値は VM の作成時に設定され、変更できません。

スケジューリング オプションの詳細については、インスタンス可用性ポリシーを設定するをご覧ください。
service-accounts/

VM に関連付けられているサービス アカウントのディレクトリ。各サービス アカウントごとに、次の情報を利用できます。

  • aliases
  • email: サービス アカウントのメールアドレス。
  • identity: VM に固有の JSON ウェブトークン。この VM メタデータ値のリクエストには、audience パラメータを含める必要があります。例: ?audience=http://www.example.com

    インスタンス ID トークンのリクエストおよび確認方法の詳細については、VM の ID を確認するをご覧ください。

  • scopes: サービス アカウントに割り当てられているアクセス スコープ。
  • token: アプリケーションの認証に使用できる OAuth2 アクセス トークン。

    アクセス トークンの詳細については、アクセス トークンを直接使用したアプリケーションの認証をご覧ください。

Compute Engine でのサービス アカウントの使用方法について詳しくは、サービス アカウントをご覧ください。
tags

VM に関連付けられているネットワーク タグを一覧にします。

ネットワーク タグの詳細については、ネットワーク タグを追加するをご覧ください。
zone VM を配置するゾーン。値は、projects/PROJECT_NUM/zones/ZONE の形式です。

事前定義されたインスタンス属性のメタデータキー

インスタンス属性の事前定義されたメタデータキーは、次のディレクトリに保存されます。

  • http://metadata.google.internal/computeMetadata/v1/instance/attributes/

次の表に、Compute Engine が instance/attributes/ メタデータ ディレクトリに自動的に作成するメタデータキーの一覧を示します。

メタデータ エントリ 説明
physical_host

コンパクト プレースメント ポリシーで作成された VM の場所を表すハッシュ文字列。

この属性の詳細については、VM の物理的な場所を確認するをご覧ください。
enable-oslogin

VM 上の SSH 認証鍵管理を有効または無効にします。

OS Login の詳細については、OS Login を設定するをご覧ください。
enable-windows-ssh（プレビュー）

Windows VM の SSH を有効または無効にします。

詳細については、SSH を使用して Windows VM に接続するをご覧ください。
enable-workload-certificate（プレビュー）

VM でマネージド ワークロード ID を有効または無効にします。

詳細については、個々の VM でマネージド ワークロード ID を有効にするをご覧ください。
vmdnssetting

VM に対してゾーン DNS とグローバル DNS を有効にします。

VM の DNS にゾーン DNS 名を使用する方法については、内部 DNS タイプにゾーン DNS を使用するをご覧ください。
ssh-keys

メタデータを使用して SSH 認証鍵を管理する場合、この属性によって、プロジェクト内の VM に接続できる公開 SSH 認証鍵を構成できます。複数の SSH 認証鍵がある場合は、改行文字（\n）で区切ります。ssh-keys 属性の値は文字列です。

例: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

OS Login が管理する SSH 認証鍵は、メタデータには表示されません。

事前定義されたゲスト属性のメタデータキー

インスタンスのゲスト属性の事前定義されたメタデータキーは、次のディレクトリに格納されます。

  • http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/

次の表に、Compute Engine が instance/guest-attributes/ メタデータ ディレクトリに自動的に作成するメタデータキーとディレクトリの一覧を示します。

メタデータ エントリ 説明
guestInventory/

VM の OS インベントリを保存します。

OS の詳細情報を収集して保存します。これには、ホスト名、カーネル バージョン、アーキテクチャ、インストール済みパッケージの詳細などの情報が含まれます。

OS インベントリの詳細については、オペレーティング システムの詳細を表示するをご覧ください。
hostkeys/

SSH ホストキーを保存します。ホストキーを使用して、特定のホストまたはマシンを識別できます。

ホストキーの詳細については、ゲスト属性を有効にしてホストキーを保存するをご覧ください。

次のステップ