REST Resource: projects.locations.runtimes

Ressource: Laufzeit

Die Definition einer Laufzeit für eine verwaltete Notebook-Instanz.

JSON-Darstellung
{
  "name": string,
  "state": enum (State),
  "healthState": enum (HealthState),
  "accessConfig": {
    object (RuntimeAccessConfig)
  },
  "softwareConfig": {
    object (RuntimeSoftwareConfig)
  },
  "metrics": {
    object (RuntimeMetrics)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeMigrationEligibility": {
    object (RuntimeMigrationEligibility)
  },

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

string

Nur Ausgabe. Der Ressourcenname der Laufzeit. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}

state

enum (State)

Nur Ausgabe. Laufzeitstatus.

healthState

enum (HealthState)

Nur Ausgabe. healthState der Laufzeit.

accessConfig

object (RuntimeAccessConfig)

Die Konfigurationseinstellungen für den Zugriff auf die Laufzeit.

softwareConfig

object (RuntimeSoftwareConfig)

Die Konfigurationseinstellungen für Software in der Laufzeit.

metrics

object (RuntimeMetrics)

Nur Ausgabe. Enthält Messwerte des Runtime-Daemons wie den Dienststatus und JupyterLab-Statistiken.

createTime

string (Timestamp format)

Nur Ausgabe. Erstellungszeit der Laufzeit.

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. Zeitpunkt der Laufzeitaktualisierung.

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".

labels

map (key: string, value: string)

Optional. Die Labels, die diesem verwalteten Notebook oder dieser Laufzeit zugeordnet werden sollen. Label-Schlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte dürfen leer sein. Wenn sie vorhanden sind, müssen sie jedoch 1 bis 63 Zeichen enthalten und RFC 1035 entsprechen. Einem Cluster können maximal 32 Labels zugewiesen werden.

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

runtimeMigrationEligibility

object (RuntimeMigrationEligibility)

Nur Ausgabe. Prüft, wie machbar eine Migration von GmN zu WbI ist.

Typ der Laufzeitumgebung. Derzeit wird nur Compute Engine-VM unterstützt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
virtualMachine

object (VirtualMachine)

Verwenden Sie ein Compute Engine-VM-Image, um die verwaltete Notebookinstanz zu starten.

Ende der sich gegenseitig ausschließenden Felder.
migrated

boolean

Nur Ausgabe. Boolescher Wert, der angibt, ob dieses Notebook zu einer Workbench-Instanz migriert wurde

VirtualMachine

Laufzeit mit virtueller Maschine für die Berechnung.

JSON-Darstellung
{
  "instanceName": string,
  "instanceId": string,
  "virtualMachineConfig": {
    object (VirtualMachineConfig)
  }
}
Felder
instanceName

string

Nur Ausgabe. Der nutzerfreundliche Name der verwalteten Compute Engine-Instanz.

instanceId

string

Nur Ausgabe. Die eindeutige Kennung der verwalteten Compute Engine-Instanz.

virtualMachineConfig

object (VirtualMachineConfig)

Konfigurationseinstellungen für virtuelle Maschinen.

VirtualMachineConfig

Die Konfigurationseinstellungen für die virtuelle Maschine.

JSON-Darstellung
{
  "zone": string,
  "machineType": string,
  "containerImages": [
    {
      object (ContainerImage)
    }
  ],
  "dataDisk": {
    object (LocalDisk)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "shieldedInstanceConfig": {
    object (RuntimeShieldedInstanceConfig)
  },
  "acceleratorConfig": {
    object (RuntimeAcceleratorConfig)
  },
  "network": string,
  "subnet": string,
  "internalIpOnly": boolean,
  "tags": [
    string
  ],
  "guestAttributes": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "nicType": enum (NicType),
  "reservedIpRange": string,
  "bootImage": {
    object (BootImage)
  }
}
Felder
zone

string

Nur Ausgabe. Die Zone, in der sich die VM befindet. Wenn Sie eine regionale Anfrage verwenden, wählt der Notebook-Dienst einen Standort in der entsprechenden Laufzeitregion aus. Bei einer GET-Anfrage ist „zone“ immer vorhanden. Beispiel: * us-central1-b

machineType

string

Erforderlich. Der Compute Engine-Maschinentyp, der für Runtimes verwendet wird. Der Kurzname ist gültig. Beispiele: * n1-standard-2 * e2-standard-8

containerImages[]

object (ContainerImage)

Optional. Verwenden Sie eine Liste von Container-Images, die als Kernels in der Notebook-Instanz verwendet werden sollen.

dataDisk

object (LocalDisk)

Erforderlich. Konfigurationseinstellungen für die Option „Datenträger“.

encryptionConfig

object (EncryptionConfig)

Optional. Verschlüsselungseinstellungen für die Datenträger der virtuellen Maschine.

shieldedInstanceConfig

object (RuntimeShieldedInstanceConfig)

Optional. Konfigurationseinstellungen für Shielded VM-Instanzen.

acceleratorConfig

object (RuntimeAcceleratorConfig)

Optional. Die Compute Engine-Beschleunigerkonfiguration für diese Laufzeit.

network

string

Optional. Das Compute Engine-Netzwerk, das für die Maschinenkommunikation verwendet werden soll. Kann nicht mit einem Subnetzwerk angegeben werden. Wenn weder network noch subnet angegeben ist, wird das Standardnetzwerk des Projekts verwendet, sofern es vorhanden ist.

Eine vollständige URL oder ein Teil eines URI. Beispiele:

  • https://www.googleapis.com/compute/v1/projects/[projectId]/global/networks/default
  • projects/[projectId]/global/networks/default

Laufzeiten sind verwaltete Ressourcen in der Google-Infrastruktur. Laufzeiten unterstützen die folgenden Netzwerkkonfigurationen:

  • Von Google verwaltetes Netzwerk (Netzwerk und Subnetz sind leer)
  • VPC des Nutzerprojekts (Netzwerk und Subnetz sind erforderlich). Erfordert die Konfiguration des privaten Dienstzugriffs.
  • Freigegebene VPC (Netzwerk und Subnetz sind erforderlich). Erfordert die Konfiguration des privaten Dienstzugriffs.
subnet

string

Optional. Das Compute Engine-Subnetzwerk, das für die Maschinenkommunikation verwendet werden soll. Kann nicht mit „network“ angegeben werden.

Eine vollständige URL oder ein teilweiser URI sind gültig. Beispiele:

  • https://www.googleapis.com/compute/v1/projects/[projectId]/regions/us-east1/subnetworks/sub0
  • projects/[projectId]/regions/us-east1/subnetworks/sub0
internalIpOnly

boolean

Optional. Wenn „true“, hat die Laufzeitumgebung nur interne IP-Adressen. Standardmäßig sind Runtimes nicht auf interne IP-Adressen beschränkt und jeder VM wird eine sitzungsspezifische externe IP-Adresse zugewiesen. Diese internalIpOnly-Einschränkung kann nur für Netzwerke mit aktivierten Subnetzwerken aktiviert werden. Alle Abhängigkeiten müssen so konfiguriert sein, dass sie ohne externe IP-Adressen zugänglich sind.

tags[]

string

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

guestAttributes

map (key: string, value: string)

Nur Ausgabe. Die Compute Engine-Gastattribute. Weitere Informationen finden Sie unter Gastattribute für Projekte und Instanzen.

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

metadata

map (key: string, value: string)

Optional. Die Compute Engine-Metadateneinträge, die der VM hinzugefügt werden sollen. Weitere Informationen finden Sie unter Projekt- und Instanzmetadaten.

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

labels

map (key: string, value: string)

Optional. Die Labels, die dieser Laufzeit zugeordnet werden sollen. Label-Schlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte dürfen leer sein. Wenn sie vorhanden sind, müssen sie jedoch 1 bis 63 Zeichen enthalten und RFC 1035 entsprechen. Einem Cluster können maximal 32 Labels zugewiesen werden.

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

nicType

enum (NicType)

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

reservedIpRange

string

Optional. Der Name des reservierten IP-Bereichs wird für VPC-Peering verwendet. Wenn der Bereich name zugewiesen ist, wird er bei der Zuordnung des Subnetzwerks verwendet.

Beispiel: managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

Der Feldwert lautet: managed-notebooks-range-c

bootImage

object (BootImage)

Optional. Boot-Image-Metadaten, die für die Laufzeit-Upgradefähigkeit verwendet werden.

LocalDisk

Eine lokal angehängte Laufwerkressource.

JSON-Darstellung
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "guestOsFeatures": [
    {
      object (RuntimeGuestOsFeature)
    }
  ],
  "index": integer,
  "initializeParams": {
    object (LocalDiskInitializeParams)
  },
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
Felder
autoDelete

boolean

Optional. Nur Ausgabe. Gibt an, ob das Laufwerk automatisch gelöscht wird, wenn die Instanz gelöscht wird (nicht jedoch, wenn das Laufwerk von der Instanz getrennt wird).

boot

boolean

Optional. Nur Ausgabe. Gibt an, dass es sich um ein Bootlaufwerk handelt. Die VM verwendet die erste Partition der Festplatte für ihr Stammdateisystem.

deviceName

string

Optional. Nur Ausgabe. Gibt einen eindeutigen Gerätenamen Ihrer Wahl an, der im /dev/disk/by-id/google-*-Baum eines Linux-Betriebssystems in der Instanz angezeigt wird. Mit diesem Namen kann das Gerät z. B. aus der Instanz heraus bereitgestellt oder in der Größe angepasst werden.

Wenn nicht angegeben, wählt der Server einen Standardgerätenamen aus, der auf dieses Laufwerk angewendet werden soll. Er hat das Format „persistent-disk-x“, wobei „x“ eine Nummer ist, die von Google Compute Engine zugewiesen wird. Dieses Feld gilt nur für Persistent Disks.

guestOsFeatures[]

object (RuntimeGuestOsFeature)

Nur Ausgabe. Gibt eine Liste der Funktionen an, die im Gastbetriebssystem aktiviert werden sollen. Gilt nur für bootfähige Images. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren.

index

integer

Nur Ausgabe. Ein nullbasierter Index für dieses Laufwerk, wobei 0 für das Bootlaufwerk reserviert ist. Wenn viele Laufwerke an eine Instanz angehängt sind, hat jedes Laufwerk eine eindeutige Indexnummer.

initializeParams

object (LocalDiskInitializeParams)

Nur Eingabe. Gibt die Parameter für ein neues Laufwerk an, das zusammen mit der neuen Instanz erstellt wird. Verwenden Sie Initialisierungsparameter, um Bootlaufwerke oder lokale SSDs zu erstellen, die an die neue Instanz angehängt werden.

Diese Property schließt die Quell-Property aus. Sie können nur eine der beiden definieren, aber nicht beide.

interface

string

Gibt die Laufwerkschnittstelle an, die zum Anhängen dieses Laufwerks verwendet werden soll. Dies kann entweder SCSI oder NVME sein. Der Standardwert ist SCSI. Für nichtflüchtige Speicher muss immer SCSI verwendet werden. Der Vorgang schlägt fehl, wenn Sie versuchen, einen nichtflüchtigen Speicher in einem anderen Format als SCSI anzuhängen. Lokale SSDs können entweder NVME oder SCSI verwenden. Informationen zu den Leistungsmerkmalen von SCSI über NVMe finden Sie unter Leistung lokaler SSDs. Zulässige Werte:

  • NVME
  • SCSI
kind

string

Nur Ausgabe. Typ der Ressource. Berechnen Sie immer „compute#attachedDisk“ für angehängte Laufwerke.

licenses[]

string

Nur Ausgabe. Alle gültigen öffentlich sichtbaren Lizenzen.

mode

string

Der Modus, in dem dieses Laufwerk angehängt werden soll, entweder READ_WRITE oder READ_ONLY. Wenn nichts angegeben ist, wird das Laufwerk standardmäßig im Modus READ_WRITE angehängt. Zulässige Werte:

  • READ_ONLY
  • READ_WRITE
source

string

Gibt eine gültige Teil- oder vollständige URL zu einer vorhandenen Persistent Disk-Ressource an.

type

string

Gibt den Typ der Festplatte an, entweder SCRATCH oder PERSISTENT. Wenn nichts angegeben ist, wird standardmäßig PERSISTENT verwendet. Zulässige Werte:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

Optional. Eine Liste der Funktionen, die im Gastbetriebssystem aktiviert werden sollen. Gilt nur für bootfähige Images. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren. Gastbetriebssystem-Features für das Bootlaufwerk.

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

string

Die ID einer unterstützten Funktion. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren.

Zulässige Werte:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

LocalDiskInitializeParams

Nur Eingabe. Gibt die Parameter für ein neues Laufwerk an, das zusammen mit der neuen Instanz erstellt wird. Verwenden Sie Initialisierungsparameter, um Bootlaufwerke oder lokale SSDs zu erstellen, die an die neue Laufzeit angehängt sind. Diese Property schließt die Quell-Property aus. Sie können nur eine der beiden definieren, aber nicht beide.

JSON-Darstellung
{
  "description": string,
  "diskName": string,
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "labels": {
    string: string,
    ...
  }
}
Felder
description

string

Optional. Geben Sie diese Property beim Erstellen des Laufwerks an.

diskName

string

Optional. Gibt den Namen des Laufwerks an. Wenn keine Angabe erfolgt, wird standardmäßig der Name der Instanz verwendet. Wenn das Laufwerk mit dem Instanznamen bereits in der angegebenen Zone/Region vorhanden ist, wird automatisch ein neuer Name generiert.

diskSizeGb

string (int64 format)

Optional. Gibt die Größe des Laufwerks in GB (Basis 2) an. Wenn Sie nichts angeben, hat das Laufwerk dieselbe Größe wie das Image (in der Regel 10 GB). Falls die Größe angegeben wird, muss sie mindestens 10 GB betragen. Standardmäßig 100 GB.

diskType

enum (DiskType)

Nur Eingabe. Der Typ des Bootlaufwerks, das an diese Instanz angehängt ist. Der Standardwert ist ein nichtflüchtiger Standardspeicher (PD_STANDARD).

labels

map (key: string, value: string)

Optional. Labels, die auf dieses Laufwerk angewendet werden sollen. Diese können später mit der Methode „disks.setLabels“ geändert werden. Dieses Feld gilt nur für Persistent Disks.

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

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.

EncryptionConfig

Stellt eine benutzerdefinierte Verschlüsselungsschlüsselkonfiguration dar, die auf eine Ressource angewendet werden kann. Dadurch werden alle Festplatten in der virtuellen Maschine verschlüsselt.

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

string

Die Cloud KMS-Ressourcen-ID des kundenverwalteten Verschlüsselungsschlüssels, der zum Schutz einer Ressource wie eines Laufwerks verwendet wird. Sie hat folgendes Format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

RuntimeShieldedInstanceConfig

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

Gibt an, ob für die 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

Gibt an, ob vTPM für die Instanz aktiviert ist. Standardmäßig aktiviert.

enableIntegrityMonitoring

boolean

Definiert, ob für die Instanz Integritätsmonitoring aktiviert ist.

Ermöglicht das Monitoring und die Attestierung der Bootintegrität der Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Baseline wird anfangs aus dem implizit vertrauenswürdigen Boot-Image abgeleitet, wenn die Instanz erstellt wird. Standardmäßig aktiviert.

RuntimeAcceleratorConfig

Definition der Arten von Hardwarebeschleunigern, die verwendet werden können. Weitere Informationen finden Sie unter Compute Engine-Beschleunigertypen. Beispiele:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
JSON-Darstellung
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
Felder
type

enum (AcceleratorType)

Beschleunigermodell.

coreCount

string (int64 format)

Anzahl der Kerne dieses Beschleunigers.

AcceleratorType

Typ dieses Beschleunigers.

Enums
ACCELERATOR_TYPE_UNSPECIFIED Der Beschleunigertyp ist nicht angegeben.
NVIDIA_TESLA_K80

Der Beschleunigertyp ist Nvidia Tesla K80.

NVIDIA_TESLA_P100 Der Beschleunigertyp ist Nvidia Tesla P100.
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_L4 Der Beschleunigertyp ist Nvidia L4.
TPU_V2 (Demnächst verfügbar) Der Beschleunigertyp ist TPU V2.
TPU_V3 (Demnächst verfügbar) Der Beschleunigertyp ist TPU V3.
NVIDIA_TESLA_T4_VWS Der Beschleunigertyp ist NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS Der Beschleunigertyp ist NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS Der Beschleunigertyp ist NVIDIA Tesla P4 Virtual Workstations.

NicType

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

Enums
UNSPECIFIED_NIC_TYPE Kein Typ angegeben.
VIRTIO_NET VIRTIO
GVNIC GVNIC

BootImage

Dieser Typ hat keine Felder.

Definition des vom Laufzeit-Image verwendeten Boot-Images. Wird verwendet, um die Laufzeitupgradefähigkeit zu ermöglichen.

Bundesland

Die Definition der Zustände dieser Laufzeit.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
STARTING Die Computing-Ebene startet die Laufzeit. Sie ist noch nicht einsatzbereit.
PROVISIONING Auf der Compute-Ebene werden die erforderlichen Frameworks installiert und die Laufzeit beim Notebook-Proxy registriert. Sie kann nicht verwendet werden.
ACTIVE Die Laufzeit wird gerade ausgeführt. Sie ist einsatzbereit.
STOPPING Die Steuerungslogik beendet die Laufzeit. Sie kann nicht verwendet werden.
STOPPED Die Laufzeit wurde beendet. Sie kann nicht verwendet werden.
DELETING Die Laufzeit wird gelöscht. Sie kann nicht verwendet werden.
UPGRADING Die Laufzeit wird aktualisiert. Sie kann nicht verwendet werden.
INITIALIZING Die Laufzeit wird erstellt und eingerichtet. Sie ist noch nicht einsatzbereit.

HealthState

Der Laufzeit-Unterstatus.

Enums
HEALTH_STATE_UNSPECIFIED Der Laufzeit-Unterstatus ist unbekannt.
HEALTHY Die Laufzeit ist bekanntermaßen fehlerfrei (z. B. werden kritische Daemons ausgeführt). Gilt für den Status AKTIV.
UNHEALTHY Die Laufzeit befindet sich in einem fehlerhaften Zustand (z. B. werden kritische Daemons nicht ausgeführt). Gilt für den Status „AKTIV“.
AGENT_NOT_INSTALLED Die Laufzeit hat den Agent für die Zustandsüberwachung nicht installiert. Gilt für den Status „AKTIV“.
AGENT_NOT_RUNNING Der Agent für das Runtime-Zustandsmonitoring wird nicht ausgeführt. Gilt für den Status „AKTIV“.

RuntimeAccessConfig

Gibt die Anmeldekonfiguration für die Laufzeit an.

JSON-Darstellung
{
  "accessType": enum (RuntimeAccessType),
  "runtimeOwner": string,
  "proxyUri": string
}
Felder
accessType

enum (RuntimeAccessType)

Der Zugriffstyp dieser Instanz.

runtimeOwner

string

Der Eigentümer dieser Laufzeit nach der Erstellung. Format: alias@example.com Derzeit wird nur ein Inhaber unterstützt.

proxyUri

string

Nur Ausgabe. Der Proxy-Endpunkt, der für den Zugriff auf die Laufzeit verwendet wird.

RuntimeAccessType

Mögliche Zugriffsarten auf die Laufzeit. Authentifizierungsmodus. Derzeit wird nur die Einzelnutzerversion unterstützt.

Enums
RUNTIME_ACCESS_TYPE_UNSPECIFIED Nicht angegebener Zugriff.
SINGLE_USER Einzelnutzeranmeldung
SERVICE_ACCOUNT Dienstkontomodus. Im Dienstkontomodus gibt der Laufzeit-Ersteller ein Dienstkonto an, das im Nutzerprojekt vorhanden ist. Feld „Laufzeitdienstkonto“ verwenden. Nutzer, die auf die Laufzeit zugreifen, benötigen die Berechtigung „ActAs“ (Service Account User).

RuntimeSoftwareConfig

Gibt die Auswahl und Konfiguration von Software in der Laufzeit an. Die Eigenschaften, die zur Laufzeit festgelegt werden sollen. Eigenschaftsschlüssel werden im Format key:value angegeben, z. B.:

  • idleShutdown: true
  • idleShutdownTimeout: 180
  • enableHealthMonitoring: true
JSON-Darstellung
{
  "notebookUpgradeSchedule": string,
  "idleShutdownTimeout": integer,
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "postStartupScript": string,
  "kernels": [
    {
      object (ContainerImage)
    }
  ],
  "postStartupScriptBehavior": enum (PostStartupScriptBehavior),
  "enableHealthMonitoring": boolean,
  "idleShutdown": boolean,
  "upgradeable": boolean,
  "disableTerminal": boolean,
  "version": string,
  "mixerDisabled": boolean
}
Felder
notebookUpgradeSchedule

string

Cron-Ausdruck in der UTC-Zeitzone, der zum Planen des automatischen Upgrades der Instanz verwendet wird. Halten Sie sich bitte an das Cron-Format.

idleShutdownTimeout

integer

Zeit in Minuten, die gewartet wird, bevor die Laufzeit heruntergefahren wird. Standard: 180 Minuten

installGpuDriver

boolean

Nvidia-Treiber automatisch installieren Standard: True

customGpuDriverPath

string

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.

postStartupScript

string

Pfad zu einem Bash-Script, das nach dem vollständigen Booten einer Notebook-Instanz automatisch ausgeführt wird. Der Pfad muss eine URL oder ein Cloud Storage-Pfad (gs://path-to-file/file-name) sein.

kernels[]

object (ContainerImage)

Optional. Verwenden Sie eine Liste von Container-Images, die als Kernels in der Notebook-Instanz verwendet werden sollen.

postStartupScriptBehavior

enum (PostStartupScriptBehavior)

Verhalten für das Post-Startscript.

enableHealthMonitoring

boolean

Prüft, ob die internen Hauptdienste ausgeführt werden. Standard: True

idleShutdown

boolean

Die Laufzeit wird nach idle_shutdown_time automatisch beendet. Standard: True

upgradeable

boolean

Nur Ausgabe. Bool-Wert, der angibt, ob in einer Image-Familie ein neueres Image verfügbar ist.

disableTerminal

boolean

Boolescher Wert, der angibt, ob das JupyterLab-Terminal verfügbar ist. Standardwert: False

version

string

Nur die Ausgabevariante des Boot-Images, z. B. M100, aus dem Release-Label des Images.

mixerDisabled

boolean

Boolescher Wert, der angibt, ob der Mixer-Client deaktiviert werden soll. Standardwert: False

PostStartupScriptBehavior

Verhalten für das Post-Startscript.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED Nicht angegebenes Verhalten des Post-Startscripts. Wird nur einmal bei der Erstellung ausgeführt.
RUN_EVERY_START Führt bei jedem Start das bei der Erstellung angegebene Post-Startscript aus.
DOWNLOAD_AND_RUN_EVERY_START Lädt das angegebene Post-Startscript bei jedem Start herunter und führt es aus.

RuntimeMetrics

Enthält Laufzeit-Daemon-Messwerte wie Statistiken zu Betriebssystem, Kernel und Sitzungen.

JSON-Darstellung
{
  "systemMetrics": {
    string: string,
    ...
  }
}
Felder
systemMetrics

map (key: string, value: string)

Nur Ausgabe. Die Systemmesswerte.

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

RuntimeMigrationEligibility

„RuntimeMigrationEligibility“ stellt die Machbarkeitsinformationen für eine Migration von GmN zu WbI dar.

JSON-Darstellung
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
Felder
warnings[]

enum (Warning)

Nur Ausgabe. Bestimmte Konfigurationen werden während der Migration auf die Standardeinstellungen zurückgesetzt.

errors[]

enum (Error)

Nur Ausgabe. Bestimmte Konfigurationen schließen eine automatische Migration von GmN aus. Eine manuelle Migration ist erforderlich.

Warnung

Eine Migrationswarnung bedeutet, dass bestimmte Konfigurationen während der Migration auf die Standardeinstellungen zurückgesetzt werden.

Enums
WARNING_UNSPECIFIED Standardtyp.
UNSUPPORTED_ACCELERATOR_TYPE Das GmN verwendet einen Beschleunigertyp, der in WbI nicht unterstützt wird. Es wird ohne Beschleuniger migriert. Nutzer können einen Beschleuniger nach der Migration anhängen.
UNSUPPORTED_OS Die GmN verwendet ein Betriebssystem, das in WbI nicht unterstützt wird (z.B. Debian 10). Es wird in WbI durch Debian 11 ersetzt.
RESERVED_IP_RANGE Für diesen GmN ist ein reservierter IP-Bereich konfiguriert, der in WbI nicht mehr gilt.
GOOGLE_MANAGED_NETWORK Dieses GmN ist mit einem von Google verwalteten Netzwerk konfiguriert. Geben Sie die Optionen network und subnet für die Migration an.
POST_STARTUP_SCRIPT Für diesen GmN ist ein Post-Startscript konfiguriert. Geben Sie optional die postStartupScriptOption für die Migration an.
SINGLE_USER Für dieses GmN ist der Einzelnutzermodus konfiguriert. Geben Sie optional die Option serviceAccount für die Migration an.

Fehler

Eine Migrationsfehlermeldung bedeutet, dass bestimmte Konfigurationen dazu führen, dass das GmN nicht für eine automatische Migration infrage kommt. Eine manuelle Migration ist erforderlich.

Enums
ERROR_UNSPECIFIED Standardtyp.
CUSTOM_CONTAINER Das GmN ist mit benutzerdefinierten Containern konfiguriert und kann nicht migriert werden.

Methoden

create

Erstellt eine neue Laufzeit in einem bestimmten Projekt und an einem bestimmten Standort.

delete

Löscht eine einzelne Laufzeit.

get

Ruft Details zu einer einzelnen Laufzeit ab.

getIamPolicy

Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.

list

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

migrate

Vorhandene Laufzeit zu einer neuen Workbench-Instanz migrieren

patch

Aktualisieren Sie die Notebook-Laufzeitkonfiguration.

reportEvent

Meldet und verarbeitet ein Laufzeitereignis.

reset

Setzt eine verwaltete Notebook-Laufzeit zurück.

setIamPolicy

Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

start

Startet eine Laufzeit für verwaltete Notebooks.

stop

Beendet eine verwaltete Notebook-Laufzeit.

switch

Laufzeit eines verwalteten Notebooks wechseln

testIamPermissions

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