Vordefinierte Metadatenschlüssel

Jeder Metadateneintrag wird auf dem Metadatenserver als Schlüssel/Wert-Paare gespeichert. Bei Metadatenschlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Ihre Schlüssel können entweder vordefinierte oder benutzerdefinierte Metadatenschlüssel sein.

Vordefinierte Metadatenschlüssel sind Metadatenschlüssel, die von Compute Engine erstellt werden. Wenn Sie eine VM erstellen, legt Compute Engine automatisch die Metadatenwerte für einige dieser Schlüssel auf dieser VM fest, z. B. die VM-Instanz-ID oder die Projekt-ID. Für vordefinierte Schlüssel, bei denen Compute Engine nicht automatisch einen Wert festlegt, können Sie aus einer Reihe von Werten auswählen, die je nach Systemkonfiguration verfügbar sind. Wenn Sie beispielsweise OS Login für eine VM aktivieren möchten, können Sie den Wert des vordefinierten Schlüssels enable-oslogin für diese VM auf TRUE setzen. Wenn Sie OS Login für diese VM deaktivieren möchten, können Sie den Wert des Schlüssels auf FALSE aktualisieren. Sie können nur die Werte für diese Schlüssel aktualisieren, nicht jedoch die Schlüssel selbst.

Dieses Dokument enthält Informationen zu den vordefinierten Metadatenschlüsseln, die Compute Engine in den Metadatenverzeichnissen instance/ und project/ bereitstellt.

Informationen zum Definieren, Kategorisieren und Sortieren von VM-Metadaten für Compute Engine finden Sie unter Informationen zu VM-Metadaten.

Vordefinierte Projekt-Metadatenschlüssel

Vordefinierte Metadatenschlüssel für Projektmetadaten werden im folgenden Verzeichnis gespeichert:

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

Die folgende Tabelle enthält eine Liste der Metadatenschlüssel und -verzeichnisse, die Compute Engine automatisch im Metadatenverzeichnis project/ erstellt:

Metadateneintrag Beschreibung
attributes/

Ein Verzeichnis mit benutzerdefinierten Metadatenwerten, die beim Starten oder Herunterfahren an die VMs in Ihrem Projekt übergeben werden. Diese benutzerdefinierten Werte können entweder Google Cloud-Attribute oder von Nutzern erstellte Metadatenwerte sein.

Eine Liste der Google Cloud-Attribute auf Projektebene, die Sie festlegen können, finden Sie unter Projektattribute.

Weitere Informationen zum Festlegen von Metadaten finden Sie unter Benutzerdefinierte Metadaten festlegen.
numeric-project-id Die numerische Projekt-ID (Projektnummer) der Instanz. Diese unterscheidet sich vom Projektnamen, der in der Google Cloud Console angezeigt wird. Dieser Wert unterscheidet sich vom project-id-Wert des Metadateneintrags.
project-id Die Projekt-ID.

Vordefinierte Projektattribut-Metadatenschlüssel

Vordefinierte Metadatenschlüssel für Projektattribute sind im folgenden Verzeichnis gespeichert:

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

Die folgende Tabelle enthält eine Liste der Metadatenschlüssel, die Compute Engine automatisch im Metadatenverzeichnis project/attributes/ erstellt:

Metadateneintrag Beschreibung
disable-legacy-endpoints

Deaktiviert Legacy-Metadatenserver-Endpunkte für alle Instanzen in Ihrem Projekt.

Legacy-Endpunkte wurden verworfen, legt immer disable-legacy-endpoints=TRUE fest.

enable-guest-attributes

Legt Gastattribute für das Projekt fest.

Gastattribute sind benutzerdefinierte Metadatenwerte für VM-Instanzen, mit denen Sie unregelmäßige Statusbenachrichtigungen, kleinere Datenmengen oder selten verwendete Daten veröffentlichen können. Diese Werte sind nützlich, um das Ende von Startskripts anzuzeigen oder sonstige unregelmäßige Statusbenachrichtigungen an andere Anwendungen zu übergeben.

Weitere Informationen zu Gastattributen finden Sie unter Gastattribute festlegen und abfragen.

enable-os-inventory

Aktiviert oder deaktiviert OS Inventory für das Projekt.

Erfasst und speichert Betriebssysteminformationen. Dazu gehören Informationen wie Hostname, Kernel-Version, Architektur und installierte Pakete.

Weitere Informationen zu OS Inventory finden Sie unter Betriebssystemdetails ansehen.

enable-oslogin

Aktiviert oder deaktiviert die SSH-Schlüsselverwaltung für Ihr Projekt.

Weitere Informationen zu OS Login finden Sie unter OS Login einrichten.

enable-windows-ssh

Aktiviert oder deaktiviert SSH für Windows-VMs.

Weitere Informationen finden Sie unter Verbindung zu Windows-VMs über SSH herstellen.

google-compute-default-region Wenn dieses Flag festgelegt ist, wird die vom Projekt verwendete Standardregion gespeichert.

Weitere Informationen zum Festlegen von Standardregionen finden Sie unter Standardregion und -zone.

google-compute-default-zone Wenn dieses Flag festgelegt ist, wird die vom Projekt verwendete Standardzone gespeichert.

Weitere Informationen zum Festlegen von Standardzonen finden Sie unter Standardregion und -zone.

ssh-keys

Wenn Sie SSH-Schlüssel mithilfe von Metadaten verwalten, können Sie mit diesem Attribut öffentliche SSH-Schlüssel konfigurieren, die eine Verbindung zu VMs in diesem Projekt herstellen können. Sollte es mehrere SSH-Schlüssel geben, wird jeder Schlüssel durch ein Zeilenvorschubzeichen abgetrennt (\n). Der Wert des ssh-keys-Attributs ist ein String.

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

SSH-Schlüssel, die von OS Login verwaltet werden, sind in Metadaten nicht sichtbar.

sshKeys Verworfen: Verwenden Sie ssh-keys.
vmdnssetting

Aktivieren Sie zonales DNS und globales DNS für die VMs in Ihrem Projekt.

Weitere Informationen zur Verwendung zonaler DNS-Namen für Ihre VMs finden Sie unter Zonal-DNS für Ihren internen DNS-Typ verwenden.

Vordefinierte Instanzmetadatenschlüssel

Vordefinierte Metadatenschlüssel für Instanzmetadaten werden im folgenden Verzeichnis gespeichert:

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

Die folgende Tabelle enthält eine Liste der Metadatenschlüssel und -verzeichnisse, die Compute Engine automatisch im Metadatenverzeichnis instance/ erstellt:

Metadateneintrag Beschreibung
attributes/

Ein Verzeichnis mit benutzerdefinierten Metadatenwerten, die die Instanz beim Starten oder beim Beenden erhält. Diese benutzerdefinierten Werte können entweder Google Cloud-Attribute oder von Nutzern erstellte Metadatenwerte sein.

Eine Liste der Google Cloud-Attribute auf Instanzebene, die Sie festlegen können, finden Sie unter Instanzattribute.

Weitere Informationen zum Festlegen benutzerdefinierter Metadaten finden Sie unter Benutzerdefinierte Metadaten festlegen.
cpu-platform

CPU-Plattform der VM.

Informationen zu CPU-Plattformen finden Sie unter CPU-Plattformen.
description Die Freitextbeschreibung einer Instanz, die mithilfe des Flags --description über die Google Cloud CLI oder die API zugewiesen wird.
disks/

Ein Verzeichnis der Laufwerke, die an die VM angehängt sind. Für jedes Laufwerk sind die folgenden Informationen verfügbar:

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

Weitere Informationen zu Laufwerken finden Sie unter Speicheroptionen.

gce-workload-certificates/(Vorabversion)

Hier werden die folgenden Endpunkte für die Funktion „Verwaltete Arbeitslastidentitäten“ gespeichert, die von Anwendungen verwendet werden, die in der VM ausgeführt werden.

  • config-status: Enthält Fehler in den Konfigurationswerten, die über die VM-Metadaten bereitgestellt werden.
  • workload-identities: Enthält die von der Compute Engine-Steuerungsebene verwalteten Identitäten. Dieser Endpunkt enthält das X.509-Zertifikat und den privaten Schlüssel für die Vertrauensdomain der VM.
  • trust-anchors: Enthält eine Reihe vertrauenswürdiger Zertifikate für die Validierung der X.509-Zertifikatskette des Peers.

Weitere Informationen finden Sie unter Arbeitslasten über mTLS bei anderen Arbeitslasten authentifizieren.

guest-attributes/

Legt Gastattribute für die VM fest. Diese benutzerdefinierten Werte können entweder Google Cloud-Attribute oder von Nutzern erstellte Metadatenwerte sein.

Eine Liste der Google Cloud-Attribute auf Instanzebene, die Sie festlegen können, finden Sie unter Instanzattribute für Instanzen.

Weitere Informationen zu Gastattributen finden Sie unter Gastattribute festlegen und abfragen.

hostname Der Hostname der VM.
id Die ID der VM. Hierbei handelt es sich um eine eindeutige numerische ID, die von Compute Engine erstellt wird. Die ID ist nützlich, um VMs zu identifizieren, wenn Sie keine VM-Namen verwenden.
image Das von der VM verwendete Betriebssystem-Image Dieser Wert hat folgendes Format: projects/IMAGE_PROJECT/global/images/IMAGE_NAME
legacy-endpoint-access/ Liste der Legacy-Endpunkte. Mögliche Werte sind 0.1 und v1beta1.
licenses/ Eine Liste mit Lizenzcode-IDs, mit denen die Lizenzen an Images, Snapshots und Laufwerke angehängt werden.
machine-type Der Maschinentyp für diese VM. Dieser Wert hat folgendes Format: projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event Gibt an, ob sich ein Wartungsereignis auf diese VM auswirkt. Weitere Informationen finden Sie unter Live-Migration.
name Der Name der VM.
network-interfaces/

Ein Verzeichnis mit Netzwerkschnittstellen. Für jede Netzwerkschnittstelle sind die folgenden Informationen verfügbar:

  • access-configs/

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

Weitere Informationen zu Netzwerkschnittstellen finden Sie unter Übersicht über mehrere Netzwerkschnittstellen.

partner-attributes/(Vorabversion)

Ein Verzeichnis mit Namespaces, in denen Metadateneinträge gespeichert werden. Die Namespaces werden von Google Cloud-Diensten erstellt, die ihre Konfigurationen mithilfe von Partnerattributen speichern. Wenn keine Dienste die Partnerattribute verwenden, ist das Verzeichnis leer.

Für verwaltete Arbeitslastidentitäten werden beispielsweise Partnerattribute für die Konfiguration verwendet.

preempted

Ein boolescher Wert, der angibt, ob eine VM bald vorzeitig beendet wird.
scheduling/

Legt die Zeitplanoptionen für die VM fest.

Die Planung der Metadatenwerte umfasst Folgendes:

  • on-host-maintenance: gibt an, ob die VM während der Hostwartung beendet oder live migriert wird.
  • automatic-restart: Wenn dieser Wert TRUE ist, wird die VM nach einem Wartungs- oder Absturzereignis automatisch neu gestartet.
  • preemptible: Wenn dieser Wert TRUE ist, ist die VM auf Abruf verfügbar. Dieser Wert wird beim Erstellen einer VM festgelegt und kann nicht geändert werden.

Weitere Informationen zu den Planungsoptionen finden Sie unter Verfügbarkeitsrichtlinien von Instanzen festlegen.

service-accounts/

Ein Verzeichnis mit Dienstkonten für diese Instanz. Für jedes Dienstkonto sind folgende Informationen verfügbar:

  • aliases
  • email: Die E-Mail-Adresse des Dienstkontos.
  • identity: Ein JSON-Webtoken, das für die Instanz eindeutig ist. Für diesen Instanzmetadatenwert müssen Sie den Parameter audience in Ihrer Anfrage angeben. Beispiel: ?audience=http://www.example.com

    Informationen zum Anfordern und Prüfen von Instanzidentitätstoken finden Sie unter VM-Identität prüfen.

  • scopes: Die Zugriffsbereiche, die dem Dienstkonto zugewiesen sind.
  • token: Ein OAuth2-Zugriffstoken, das zur Authentifizierung von Anwendungen verwendet werden kann.

    Weitere Informationen zu Zugriffstoken finden Sie unter Anwendungen direkt mit Zugriffstoken authentifizieren.

Weitere Informationen zur Verwendung von Dienstkonten durch Compute Engine finden Sie unter Dienstkonten.

tags

Listet alle Netzwerk-Tags auf, die der VM zugeordnet sind.

Weitere Informationen zu Netzwerktags finden Sie unter Netzwerktags konfigurieren.

zone Die Zone, in der sich die VM befindet. Dieser Wert hat folgendes Format: projects/PROJECT_NUM/zones/ZONE

Vordefinierte Instanzattribut-Metadatenschlüssel

Vordefinierte Metadatenschlüssel für Instanzattribute werden im folgenden Verzeichnis gespeichert:

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

Die folgende Tabelle enthält eine Liste der Metadatenschlüssel, die Compute Engine automatisch im Metadatenverzeichnis instance/attributes/ erstellt:

Metadateneintrag Beschreibung
physical_host

Ein Hash-String, der den Speicherort einer VM darstellt, die mit einer kompakten Platzierungsrichtlinie erstellt wurde.

Weitere Informationen zu diesem Attribut finden Sie unter Physische VM-Standorte prüfen.

enable-oslogin

Aktiviert oder deaktiviert die SSH-Schlüsselverwaltung auf Ihrer VM.

Weitere Informationen zu OS Login finden Sie unter OS Login einrichten.

enable-windows-ssh (Vorschau)

Aktiviert oder deaktiviert SSH für Windows-VMs.

Weitere Informationen finden Sie unter Verbindung zu Windows-VMs über SSH herstellen.

enable-workload-certificate (Vorschau)

Aktiviert oder deaktiviert verwaltete Arbeitslastidentitäten auf einer VM.

Weitere Informationen finden Sie unter Verwaltete Arbeitslastidentitäten für einzelne VMs aktivieren.
vmdnssetting

Zonales DNS und globales DNS für die VM aktivieren

Weitere Informationen zur Verwendung zonaler DNS-Namen für das DNS Ihrer VMs finden Sie unter Zonal-DNS für Ihren internen DNS-Typ verwenden.

ssh-keys

Wenn Sie SSH-Schlüssel mithilfe von Metadaten verwalten, können Sie mit diesem Attribut öffentliche SSH-Schlüssel konfigurieren, die eine Verbindung zu VMs in diesem Projekt herstellen können. Sollte es mehrere SSH-Schlüssel geben, wird jeder Schlüssel durch ein Zeilenvorschubzeichen abgetrennt (\n). Der Wert des ssh-keys-Attributs ist ein String.

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

SSH-Schlüssel, die von OS Login verwaltet werden, sind in Metadaten nicht sichtbar.

Vordefinierte Metadatenattribute für Gastattribute

Vordefinierte Metadatenschlüssel für Gastattribute von Instanzen werden im folgenden Verzeichnis gespeichert:

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

Die folgende Tabelle enthält eine Liste der Metadatenschlüssel und -verzeichnisse, die Compute Engine automatisch im Metadatenverzeichnis instance/guest-attributes/ erstellt:

Metadateneintrag Beschreibung
guestInventory/

Speichert OS Inventory für die VM.

Erfasst und speichert Betriebssysteminformationen. Dazu gehören Informationen wie Hostname, Kernel-Version, Architektur und installierte Paketdetails.

Weitere Informationen zu OS Inventory finden Sie unter Betriebssystemdetails ansehen.

hostkeys/

Speichert SSH-Hostschlüssel. Hostschlüssel können zur Identifizierung eines bestimmten Hosts oder Computers verwendet werden.

Informationen zu Hostschlüsseln finden Sie unter Hostschlüssel speichern, indem Sie Gastattribute aktivieren.

Nächste Schritte