REST Resource: projects.locations.instances

Ressource: Instanz

Die Definition einer Notebook-Instanz.

JSON-Darstellung 
{
  "name": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "creator": string,
  "state": enum (State),
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "id": string,
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "disableProxyAccess": boolean,
  "labels": {
    string: string,
    ...
  },
  "thirdPartyProxyUrl": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "enableThirdPartyIdentity": boolean,
  "enableManagedEuc": boolean,
  "enableDeletionProtection": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gceSetup": {
    object (GceSetup)
  }
  // End of mutually exclusive fields.
}
Felder
name

string

Nur Ausgabe. ID. Der Name dieser Notebook-Instanz. Format: projects/{projectId}/locations/{location}/instances/{instanceId}
proxyUri

string

Nur Ausgabe. Der Proxy-Endpunkt, der für den Zugriff auf das Jupyter-Notebook verwendet wird.
instanceOwners[]

string

Optional. Der Eigentümer dieser Instanz nach der Erstellung. Format: alias@example.com

Derzeit wird nur ein Inhaber unterstützt. Wenn nicht angegeben, können alle Dienstkontonutzer des Dienstkontos Ihrer VM-Instanz die Instanz verwenden.
creator

string

Nur Ausgabe. E‑Mail-Adresse der Organisation, die die ursprüngliche Anfrage „instances.create“ gesendet hat.
state

enum (State)

Nur Ausgabe. Der Status dieser Instanz.
upgradeHistory[]

object (UpgradeHistoryEntry)

Nur Ausgabe. Der Upgradeverlauf dieser Instanz.
id

string

Nur Ausgabe. Eindeutige ID der Ressource.
healthState

enum (HealthState)

Nur Ausgabe. healthState der Instanz.
healthInfo

map (key: string, value: string)

Nur Ausgabe. Zusätzliche Informationen zum Instanzstatus. Beispiel:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Nur Ausgabe. Erstellungszeitpunkt der Instanz.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Uhrzeit der Instanzaktualisierung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
disableProxyAccess

boolean

Optional. Wenn „true“, wird die Notebook-Instanz nicht beim Proxy registriert.
labels

map (key: string, value: string)

Optional. Labels, die auf diese Instanz angewendet werden sollen. Diese können später mit der Methode „instances.patch“ geändert werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
thirdPartyProxyUrl

string

Nur Ausgabe. Der Proxy-Endpunkt für Workforce-Pools, der für den Zugriff auf das Jupyter-Notebook verwendet wird.
satisfiesPzs

boolean

Nur Ausgabe. Reserviert für die zukünftige Verwendung für die Zonentrennung.
satisfiesPzi

boolean

Nur Ausgabe. Reserviert für die zukünftige Verwendung für die Zonenisolierung.
enableThirdPartyIdentity

boolean

Optional. Flag, das angibt, dass auf ein Notebook mit einem externen Identitätsanbieter zugegriffen werden kann.
enableManagedEuc

boolean

Optional. Flag zum Aktivieren verwalteter Anmeldedaten von Endnutzern für die Instanz.
enableDeletionProtection

boolean

Optional. Wenn „true“, wird der Löschschutz für diese Workbench-Instanz aktiviert. Wenn „false“ festgelegt ist, wird der Löschschutz für diese Workbench-Instanz deaktiviert.
Einrichtung für die Notebook-Instanz. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
gceSetup

object (GceSetup)

Optional. Compute Engine-Einrichtung für das Notebook. Verwendet im Notebook definierte Felder.
Ende der sich gegenseitig ausschließenden Felder.

GceSetup

Die Definition, wie eine VM-Instanz außerhalb von „Ressourcen und Identität“ konfiguriert wird.

JSON-Darstellung 
{
  "machineType": string,
  "minCpuPlatform": string,
  "acceleratorConfigs": [
    {
      object (AcceleratorConfig)
    }
  ],
  "serviceAccounts": [
    {
      object (ServiceAccount)
    }
  ],
  "bootDisk": {
    object (BootDisk)
  },
  "dataDisks": [
    {
      object (DataDisk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "networkInterfaces": [
    {
      object (NetworkInterface)
    }
  ],
  "disablePublicIp": boolean,
  "tags": [
    string
  ],
  "metadata": {
    string: string,
    ...
  },
  "systemMetadata": {
    string: string,
    ...
  },
  "enableIpForwarding": boolean,
  "gpuDriverConfig": {
    object (GPUDriverConfig)
  },
  "confidentialInstanceConfig": {
    object (ConfidentialInstanceConfig)
  },
  "instanceId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of mutually exclusive fields.
}
Felder
machineType

string

Optional. Der Maschinentyp der VM-Instanz. https://cloud.google.com/compute/docs/machine-resource
minCpuPlatform

string

Optional. Die Mindest-CPU-Plattform, die für diese Instanz verwendet werden soll. Die Liste der gültigen Werte finden Sie unter https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones.
acceleratorConfigs[]

object (AcceleratorConfig)

Optional. Die auf dieser Instanz verwendeten Hardwarebeschleuniger. Wenn Sie Beschleuniger verwenden, muss Ihre Konfiguration genügend vCPUs und Arbeitsspeicher für die ausgewählte machineType haben. Derzeit wird nur eine Accelerator-Konfiguration unterstützt.
serviceAccounts[]

object (ServiceAccount)

Optional. Das Dienstkonto, das als Identität für die VM-Instanz dient. Derzeit wird nur ein Dienstkonto unterstützt.
bootDisk

object (BootDisk)

Optional. Das Bootlaufwerk für die VM.
dataDisks[]

object (DataDisk)

Optional. Datenlaufwerke, die an die VM-Instanz angehängt sind. Derzeit wird nur eine Datenfestplatte unterstützt.
shieldedInstanceConfig

object (ShieldedInstanceConfig)

Optional. Shielded VM-Konfiguration. Images, die unterstützte Shielded VM-Funktionen verwenden.
networkInterfaces[]

object (NetworkInterface)

Optional. Die Netzwerkschnittstellen für die VM. Es wird nur eine Schnittstelle unterstützt.
disablePublicIp

boolean

Optional. Wenn „true“, wird dieser VM-Instanz keine externe IP-Adresse zugewiesen.
tags[]

string

Optional. Die Compute Engine-Netzwerk-Tags, die der Laufzeit hinzugefügt werden sollen (siehe Netzwerk-Tags hinzufügen).
metadata

map (key: string, value: string)

Optional. Benutzerdefinierte Metadaten, die auf diese Instanz angewendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemMetadata

map (key: string, value: string)

Nur Ausgabe. Stellt die vom System verwalteten Metadaten für diese Instanz dar: die Teilmenge von metadata, deren Schlüssel als Workbench-Systemschlüssel erkannt werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
enableIpForwarding

boolean

Optional. Flag zum Aktivieren oder Deaktivieren der IP-Weiterleitung. Standardmäßig ist „false“/„off“ festgelegt. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpuDriverConfig

object (GPUDriverConfig)

Optional. Konfiguration für GPU-Treiber.
confidentialInstanceConfig

object (ConfidentialInstanceConfig)

Optional. Konfiguration vertraulicher Instanzen.
instanceId

string

Nur Ausgabe. Die eindeutige ID der Compute Engine-Instanzressource.
Typ des Images. Kann „VM-Image“ oder „Container-Image“ sein. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
vmImage

object (VmImage)

Optional. Verwenden Sie ein Compute Engine-VM-Image, um die Notebook-Instanz zu starten.
containerImage

object (ContainerImage)

Optional. Verwenden Sie ein Container-Image, um die Notebook-Instanz zu starten.
Ende der sich gegenseitig ausschließenden Felder.

AcceleratorConfig

Eine Beschleunigerkonfiguration für eine VM-Instanz. Definition eines Hardwarebeschleunigers. Kombinationen aus type und coreCount werden nicht geprüft. TPUs werden nicht unterstützt. Eine gültige Kombination finden Sie unter GPUs in Compute Engine.

JSON-Darstellung 
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
Felder
type

enum (AcceleratorType)

Optional. Typ dieses Beschleunigers.
coreCount

string (int64 format)

Optional. Anzahl der Kerne dieses Beschleunigers.

AcceleratorType

Definition der Arten von Hardwarebeschleunigern, die auf dieser Instanz verwendet werden können.

Enums
ACCELERATOR_TYPE_UNSPECIFIED Der Beschleunigertyp ist nicht angegeben.
NVIDIA_TESLA_P100

Nicht mehr unterstützt: Verwenden Sie stattdessen NVIDIA_TESLA_T4 (N1) oder NVIDIA_L4 (G2). Die NVIDIA Tesla P100-GPU wird flottenweit von Compute Engine außer Betrieb genommen und ist nicht mehr für neue Instanzen verfügbar.
NVIDIA_TESLA_V100 Der Beschleunigertyp ist Nvidia Tesla V100.
NVIDIA_TESLA_P4 Der Beschleunigertyp ist Nvidia Tesla P4.
NVIDIA_TESLA_T4 Der Beschleunigertyp ist Nvidia Tesla T4.
NVIDIA_TESLA_A100 Der Beschleunigertyp ist „Nvidia Tesla A100 – 40 GB“.
NVIDIA_A100_80GB Der Beschleunigertyp ist „Nvidia Tesla A100 – 80 GB“.
NVIDIA_L4 Der Beschleunigertyp ist Nvidia Tesla L4.
NVIDIA_H100_80GB Der Beschleunigertyp ist „Nvidia Tesla H100 – 80 GB“.
NVIDIA_H100_MEGA_80GB Der Beschleunigertyp ist „Nvidia Tesla H100 – MEGA 80 GB“.
NVIDIA_H200_141GB Der Beschleunigertyp ist Nvidia Tesla H200 – 141 GB.
NVIDIA_TESLA_T4_VWS Der Beschleunigertyp ist NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS

Nicht mehr unterstützt: Verwenden Sie stattdessen NVIDIA_TESLA_T4_VWS. Die NVIDIA Tesla P100-GPU (Virtual Workstations) wird flottenweit von Compute Engine außer Betrieb genommen und ist nicht mehr für neue Instanzen verfügbar.
NVIDIA_TESLA_P4_VWS Der Beschleunigertyp ist NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 Der Beschleunigertyp ist NVIDIA B200.
NVIDIA_RTX6000 NVIDIA RTX 6000

ServiceAccount

Ein Dienstkonto, das als Identität fungiert.

JSON-Darstellung 
{
  "email": string,
  "scopes": [
    string
  ]
}
Felder
email

string

Optional. E-Mail-Adresse des Dienstkontos.
scopes[]

string

Nur Ausgabe. Die Liste der Bereiche, die für dieses Dienstkonto verfügbar gemacht werden sollen. Wird vom CLH auf https://www.googleapis.com/auth/cloud-platform festgelegt.

VmImage

Definition eines benutzerdefinierten Compute Engine-VM-Images zum Starten einer Notebook-Instanz, wobei die Umgebung direkt auf der VM installiert ist.

JSON-Darstellung 
{
  "project": string,
  "imageDescription": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "name": string,
  "family": string
  // End of mutually exclusive fields.
}
Felder
project

string

Erforderlich. Der Name des Google Cloud-Projekts, zu dem dieses VM-Image gehört. Format: {projectId}
imageDescription

string

Nur Ausgabe. Eine menschenlesbare Beschreibung des Images, das auf der Instanz ausgeführt wird (z. B. „Debian 11, Python 3.10“), die zur Lesezeit aus der Konfiguration der Image-Version (der Source of Truth) abgeleitet wird. Wird für nicht erkannte Bootlaufwerk-Images auf „Benutzerdefiniert“ gesetzt.
Der Verweis auf ein externes Compute Engine-VM-Image. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
name

string

Optional. Suchen Sie anhand des VM-Image-Namens nach dem Image.
family

string

Optional. Verwenden Sie diese VM-Image-Familie, um das Image zu finden. Das neueste Image in dieser Familie wird verwendet.
Ende der sich gegenseitig ausschließenden Felder.

ContainerImage

Definition eines Container-Images zum Starten einer Notebook-Instanz mit der in einem Container installierten Umgebung.

JSON-Darstellung 
{
  "repository": string,
  "tag": string
}
Felder
repository

string

Erforderlich. Der Pfad zum Container-Image-Repository. Beispiel: gcr.io/{projectId}/{imageName}
tag

string

Optional. Das Tag des Container-Images. Wenn nichts angegeben ist, wird standardmäßig das neueste Tag verwendet.

BootDisk

Definition eines Bootlaufwerks.

JSON-Darstellung 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string
}
Felder
diskSizeGb

string (int64 format)

Optional. Die Größe des Bootlaufwerks in GB, das an diese Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Wenn keine Angabe erfolgt, wird standardmäßig der empfohlene Wert von 150 GB verwendet.
diskType

enum (DiskType)

Optional. Gibt den Typ des Laufwerks an.
diskEncryption

enum (DiskEncryption)

Optional. Die auf den Boot- und Datenlaufwerken verwendete Laufwerkverschlüsselungsmethode. Der Standardwert ist GMEK.
kmsKey

string

Optional. Der KMS-Schlüssel, der zum Verschlüsseln der Laufwerke verwendet wird. Gilt nur, wenn „diskEncryption“ CMEK ist. Format: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Weitere Informationen zur Verwendung eigener Verschlüsselungsschlüssel

DiskType

Mögliche Laufwerkstypen.

Enums
DISK_TYPE_UNSPECIFIED Der Laufwerkstyp wurde nicht festgelegt.
PD_STANDARD Nichtflüchtiger Standardspeicher
PD_SSD Typ des nichtflüchtiger SSD-Speicher.
PD_BALANCED Typ des abgestimmten nichtflüchtigen Speichers.
PD_EXTREME Typ des extrem nichtflüchtigen Speichers.
HYPERDISK_BALANCED Stellt den Persistent Disk-Typ „Hyperdisk Balanced“ dar. Kann als Bootlaufwerk oder Datenlaufwerk verwendet werden.
HYPERDISK_EXTREME Stellt den Persistent Disk-Typ „Hyperdisk Extreme“ dar. Kann nur als Datenlaufwerk verwendet werden.
HYPERDISK_THROUGHPUT Stellt den Persistent Disk-Typ „Hyperdisk Throughput“ dar. Kann nur als Datenlaufwerk verwendet werden.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Stellt den nichtflüchtigen Speicher vom Typ „Hyperdisk Balanced High Availability“ dar. Kann als Bootlaufwerk oder Datenlaufwerk verwendet werden.
HYPERDISK_ML Stellt den Persistent Disk-Typ „Hyperdisk ML“ dar. Kann als Bootlaufwerk oder Datenlaufwerk verwendet werden.

DiskEncryption

Definition der Optionen für die Laufwerkverschlüsselung.

Enums
DISK_ENCRYPTION_UNSPECIFIED Die Laufwerksverschlüsselung ist nicht angegeben.
GMEK Verwenden Sie von Google verwaltete Verschlüsselungsschlüssel, um das Bootlaufwerk zu verschlüsseln.
CMEK Verwenden Sie vom Kunden verwaltete Verschlüsselungsschlüssel, um das Bootlaufwerk zu verschlüsseln.

DataDisk

Eine an eine Instanz angehängte Laufwerksressource.

JSON-Darstellung 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "resourcePolicies": [
    string
  ]
}
Felder
diskSizeGb

string (int64 format)

Optional. Die Größe des Laufwerks in GB, das an diese VM-Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Wenn keine Angabe erfolgt, wird standardmäßig 100 verwendet.
diskType

enum (DiskType)

Optional. Gibt den Typ des Laufwerks an.
diskEncryption

enum (DiskEncryption)

Optional. Die auf den Boot- und Datenlaufwerken verwendete Laufwerkverschlüsselungsmethode. Der Standardwert ist GMEK.
kmsKey

string

Optional. Der KMS-Schlüssel, der zum Verschlüsseln der Laufwerke verwendet wird. Gilt nur, wenn „diskEncryption“ CMEK ist. Format: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Weitere Informationen zur Verwendung eigener Verschlüsselungsschlüssel
resourcePolicies[]

string

Optional. Die auf das Datenlaufwerk anzuwendenden Ressourcenrichtlinien.

ShieldedInstanceConfig

Eine Reihe von Optionen für Shielded Instances. Weitere Informationen finden Sie unter Images mit unterstützten Shielded VM-Funktionen. Nicht alle Kombinationen sind gültig.

JSON-Darstellung 
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
Felder
enableSecureBoot

boolean

Optional. Gibt an, ob für die VM-Instanz Secure Boot aktiviert ist.

Secure Boot sorgt dafür, dass das System nur authentische Software ausführt. Dazu wird die digitale Signatur aller Bootkomponenten überprüft und der Bootvorgang angehalten, wenn die Signaturüberprüfung fehlschlägt. Standardmäßig deaktiviert.
enableVtpm

boolean

Optional. Gibt an, ob das vTPM für die VM-Instanz aktiviert ist.
enableIntegrityMonitoring

boolean

Optional. Gibt an, ob für die VM-Instanz das Integritätsmonitoring aktiviert ist.

Ermöglicht die Überwachung und Attestierung der Bootintegrität der VM-Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Baseline wird anfangs aus dem implizit vertrauenswürdigen Boot-Image abgeleitet, wenn die VM-Instanz erstellt wird.

NetworkInterface

Die Definition einer Netzwerkschnittstellenressource, die an eine VM angehängt ist.

JSON-Darstellung 
{
  "network": string,
  "subnet": string,
  "nicType": enum (NicType),
  "accessConfigs": [
    {
      object (AccessConfig)
    }
  ],
  "internalIp": string
}
Felder
network

string

Optional. Der Name der VPC, in der sich diese VM-Instanz befindet. Format: projects/{projectId}/global/networks/{network_id}
subnet

string

Optional. Der Name des Subnetzes, in dem sich diese VM-Instanz befindet. Format: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
nicType

enum (NicType)

Optional. Der Typ der vNIC, die auf dieser Schnittstelle verwendet werden soll. Das kann gVNIC oder VirtioNet sein.
accessConfigs[]

object (AccessConfig)

Optional. Ein Array von Konfigurationen für diese Schnittstelle. Derzeit wird nur eine Zugriffskonfiguration unterstützt: ONE_TO_ONE_NAT. Wenn keine accessConfigs angegeben sind, hat die Instanz über eine sitzungsspezifische externe IP-Adresse externen Internetzugriff.
internalIp

string

Optional. Interne IP-Adresse, die mit dieser Instanz verknüpft ist. Geben Sie eine nicht verwendete statische interne IP-Adresse an, die für das Subnetz verfügbar ist, in dem sich diese Instanz befindet. Lassen Sie dieses Feld leer, um eine IP-Adresse aus dem sitzungsspezifischen Bereich des Subnetzes zu verwenden.

NicType

Der Typ des vNIC-Treibers. Der Standardwert sollte NIC_TYPE_UNSPECIFIED sein.

Enums
NIC_TYPE_UNSPECIFIED Kein Typ angegeben.
VIRTIO_NET VIRTIO
GVNIC GVNIC

AccessConfig

Eine Zugriffskonfiguration, die an die Netzwerkschnittstelle einer Instanz angehängt ist.

JSON-Darstellung 
{
  "externalIp": string
}
Felder
externalIp

string

Optional. Externe IP-Adresse, die mit dieser Instanz verknüpft ist. Geben Sie eine nicht verwendete statische externe IP-Adresse an, die für das Projekt verfügbar ist, oder lassen Sie dieses Feld undefiniert, um eine IP-Adresse aus einem freigegebenen Pool mit sitzungsspezifischen IP-Adressen zu verwenden. Wenn Sie eine statische externe IP-Adresse angeben, muss sie sich in derselben Region wie die Zone der Instanz befinden.

GPUDriverConfig

Eine GPU-Treiberkonfiguration

JSON-Darstellung 
{
  "enableGpuDriver": boolean,
  "customGpuDriverPath": string
}
Felder
enableGpuDriver

boolean

Optional. Gibt an, ob der Endnutzer Google Cloud autorisiert, den GPU-Treiber auf dieser VM-Instanz zu installieren. Wenn dieses Feld leer ist oder auf „false“ gesetzt ist, wird der GPU-Treiber nicht installiert. Gilt nur für Instanzen mit GPUs.
customGpuDriverPath

string

Optional. Geben Sie einen benutzerdefinierten Cloud Storage-Pfad an, in dem der GPU-Treiber gespeichert ist. Wenn nichts angegeben ist, wählen wir automatisch aus offiziellen GPU-Treibern aus.

ConfidentialInstanceConfig

Eine Reihe von Optionen für vertrauliche Instanzen.

JSON-Darstellung 
{
  "confidentialInstanceType": enum (ConfidentialInstanceType)
}
Felder
confidentialInstanceType

enum (ConfidentialInstanceType)

Optional. Definiert den Typ der von der vertraulichen Instanz verwendeten Technologie.

ConfidentialInstanceType

Der Typ der vertraulichen Instanz.

Enums
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Kein Typ angegeben. Verwenden Sie diesen Wert nicht.
SEV AMD Secure Encrypted Virtualization.

Bundesland

Die Definition der Zustände dieser Instanz.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
STARTING Die Steuerungslogik startet die Instanz.
PROVISIONING Die Steuerungslogik installiert die erforderlichen Frameworks und registriert die Instanz beim Notebook-Proxy.
ACTIVE Die Instanz wird ausgeführt.
STOPPING Die Steuerungslogik beendet die Instanz.
STOPPED Die Instanz wurde angehalten.
DELETED Die Instanz wird gelöscht.
UPGRADING Die Instanz wird aktualisiert.
INITIALIZING Die Instanz wird gerade erstellt.
SUSPENDING Die Instanz wird angehalten.
SUSPENDED Die Instanz wurde gesperrt.
ORPHANED Die Instanz hat keine VM. Bei einem Upgrade wurde das Original entfernt und es konnte kein Ersatz erstellt werden. Die Datenfestplatte und alle Snapshots sind intakt. Wiederholen Sie das Upgrade, um es abzuschließen, oder führen Sie ein Rollback der Instanz auf den Snapshot durch, der vor dem Start des Upgrades erstellt wurde.

UpgradeHistoryEntry

Der Eintrag des VM-Image-Upgrade-Verlaufs.

JSON-Darstellung 
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "action": enum (Action),
  "targetVersion": string
}
Felder
snapshot

string

Optional. Der Snapshot des Bootlaufwerks dieser Notebook-Instanz vor dem Upgrade.
vmImage

string

Optional. Das VM-Image vor diesem Instanz-Upgrade.
containerImage

string

Optional. Das Container-Image vor dem Upgrade dieser Instanz.
framework

string

Optional. Das Framework dieser Notebook-Instanz.
version

string

Optional. Die Version der Notebook-Instanz vor diesem Upgrade.
state

enum (State)

Nur Ausgabe. Der Status dieses Eintrags im Upgradeverlauf der Instanz.
createTime

string (Timestamp format)

Nicht veränderbar. Der Zeitpunkt, zu dem dieser Eintrag im Upgradeverlauf der Instanz erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
action

enum (Action)

Optional. Aktion Rollback oder Upgrade
targetVersion

string

Optional. Ziel-VM-Version, z. B. „m63“.

Bundesland

Die Definition der Status dieses Upgradeverlaufseintrags.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
STARTED Das Upgrade der Instanz wurde gestartet.
SUCCEEDED Das Instanzupgrade wurde durchgeführt.
FAILED Das Instanzupgrade ist fehlgeschlagen.

Aktion

Die Definition der Vorgänge dieses Upgradeverlaufseintrags.

Enums
ACTION_UNSPECIFIED Vorgang ist nicht angegeben.
UPGRADE Upgrade durchführen.
ROLLBACK Rollback auslösen.

HealthState

Der Systemzustand der Instanz.

Enums
HEALTH_STATE_UNSPECIFIED Der Unterstatus der Instanz ist unbekannt.
HEALTHY Die Instanz ist bekanntermaßen in einem fehlerfreien Zustand (z. B. werden kritische Daemons ausgeführt). Gilt für den Status „ACTIVE“.
UNHEALTHY Die Instanz ist bekanntermaßen fehlerhaft (z. B. werden kritische Daemons nicht ausgeführt). Gilt für den Status „AKTIV“.
AGENT_NOT_INSTALLED Auf der Instanz ist kein Agent für die Zustandsüberwachung installiert. Gilt für den Status „AKTIV“.
AGENT_NOT_RUNNING Der Agent für die Zustandsüberwachung der Instanz wird nicht ausgeführt. Gilt für den Status „AKTIV“.

Methoden

checkUpgradability

 Prüft, ob eine Notebook-Instanz aktualisiert werden kann.

create

 Erstellt eine neue Instanz in einem angegebenen Projekt und an einem angegebenen Ort.

delete

 Löscht eine einzelne Instanz.

diagnose

 Erstellt eine Diagnosedatei und führt das Diagnosetool für eine Instanz aus.

get

 Ruft Details zu einer einzelnen Instanz ab.

getConfig

 Gibt verschiedene Konfigurationsparameter zurück.

getIamPolicy

 Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.

list

 Listet Instanzen in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Mit UpdateInstance wird eine Instanz aktualisiert.

reset

 Setzt eine Notebook-Instanz zurück.

resizeDisk

 Größe eines Notebook-Instanzlaufwerks auf eine höhere Kapazität ändern

restore

 Mit RestoreInstance wird eine Instanz aus einer BackupSource wiederhergestellt.

rollback

 Führt ein Rollback einer Notebook-Instanz auf die vorherige Version durch.

setIamPolicy

 Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

start

 Startet eine Notebook-Instanz.

stop

 Beendet eine Notebook-Instanz.

testIamPermissions

 Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.

upgrade

 Führt ein Upgrade einer Notebook-Instanz auf die neueste Version durch.