Package google.cloud.notebooks.v2

Index

NotebookService

API v2-Dienst für Workbench-Notebook-Instanzen.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Löscht eine einzelne Instanz.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
getConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Gibt verschiedene Konfigurationsparameter zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Ruft Details zu einer einzelnen Instanz ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Setzt eine Notebookinstanz zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Größe des Laufwerks einer Notebook-Instanz auf eine höhere Kapazität ändern

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

Mit RestoreInstance wird eine Instanz aus einer BackupSource wiederhergestellt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Startet eine Notebook-Instanz.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Beendet eine Notebookinstanz.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

Mit UpdateInstance wird eine Instanz aktualisiert.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.

AcceleratorConfig

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

Felder
type

AcceleratorType

Optional. Typ dieses Beschleunigers.
core_count

int64

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 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_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 Der Beschleunigertyp ist NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS Der Beschleunigertyp ist NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 Der Beschleunigertyp ist NVIDIA B200.

AccessConfig

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

Felder
external_ip

string

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.

BootDisk

Die Definition eines Bootlaufwerks.

Felder
disk_size_gb

int64

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

DiskType

Optional. Gibt den Typ des Laufwerks an.
disk_encryption

DiskEncryption

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

string

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

Weitere Informationen zur Verwendung eigener Verschlüsselungsschlüssel

CheckInstanceUpgradabilityRequest

Anfrage zum Prüfen, ob eine Notebook-Instanz aktualisiert werden kann.

Felder
notebook_instance

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource notebookInstance:

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

Antwort auf die Frage, ob eine Notebook-Instanz aktualisiert werden kann.

Felder
upgradeable

bool

Ob eine Instanz aktualisiert werden kann.
upgrade_version

string

Die Version, auf die diese Instanz aktualisiert wird, wenn der Upgrade-Endpunkt aufgerufen wird. Dieses Feld wird nur ausgefüllt, wenn „field_upgradeable“ auf „true“ gesetzt ist.
upgrade_info

string

Zusätzliche Informationen zum Upgrade.
upgrade_image

string

Der neue Self-Link des Bildes, auf das diese Instanz aktualisiert wird, wenn der Upgrade-Endpunkt aufgerufen wird. Dieses Feld wird nur ausgefüllt, wenn „field_upgradeable“ auf „true“ gesetzt ist.

ConfidentialInstanceConfig

Eine Reihe von Optionen für vertrauliche Instanzen.

Felder
confidential_instance_type

ConfidentialInstanceType

Optional. Definiert den Typ der Technologie, die von der vertraulichen Instanz verwendet wird.

ConfidentialInstanceType

Der Typ der vertraulichen Instanz.

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

Konfiguration

Antwort zum Abrufen von WbI-Konfigurationen an einem Standort

Felder
default_values

DefaultValues

Nur Ausgabe. Die Standardwerte für die Konfiguration.
supported_values

SupportedValues

Nur Ausgabe. Die unterstützten Werte für die Konfiguration.
available_images[]

ImageRelease

Nur Ausgabe. Die Liste der verfügbaren Bilder zum Erstellen eines Web-Image.
disable_workbench_legacy_creation

bool

Nur Ausgabe. Flag zum Deaktivieren der Erstellung von Legacy-Workbench-Notebooks (nutzerverwaltete Notebooks und von Google verwaltete Notebooks).

ContainerImage

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

Felder
repository

string

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

string

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

CreateInstanceRequest

Anfrage zum Erstellen einer Notebook-Instanz.

Felder
parent

string

Erforderlich. Format: parent=projects/{project_id}/locations/{location}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent:

  • notebooks.instances.create
instance_id

string

Erforderlich. Benutzerdefinierte eindeutige ID dieser Instanz.
instance

Instance

Erforderlich. Die zu erstellende Instanz.
request_id

string

Optional. UUID für idempotente Anfrage.

DataDisk

Eine an eine Instanz angehängte Laufwerksressource.

Felder
disk_size_gb

int64

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

DiskType

Optional. Nur Eingabe. Gibt den Typ des Laufwerks an.
disk_encryption

DiskEncryption

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

string

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

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

string

Optional. Die Ressourcenrichtlinien, die auf den Datenträger angewendet werden sollen.

DefaultValues

„DefaultValues“ steht für die Standardkonfigurationswerte.

Felder
machine_type

string

Nur Ausgabe. Der Standardmaschinentyp, der vom Backend verwendet wird, wenn er nicht vom Nutzer angegeben wird.

DeleteInstanceRequest

Anfrage zum Löschen einer Notebook-Instanz.

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.delete
request_id

string

Optional. UUID für idempotente Anfrage.

DiagnoseInstanceRequest

Anfrage zum Erstellen einer Diagnosedatei für Notebook-Instanzen.

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

Erforderlich. Definiert Flags, die zum Ausführen des Diagnosetools verwendet werden
timeout_minutes

int32

Optional. Maximale Zeit in Minuten, bevor für den Vorgang ein Zeitlimit überschritten wird.

DiagnosticConfig

Definiert Flags, die zum Ausführen des Diagnosetools verwendet werden

Felder
gcs_bucket

string

Erforderlich. Speicherort des Cloud Storage-Bucket des Nutzers (ERFORDERLICH). Muss mit dem Pfadpräfix (gs://$GCS_BUCKET) formatiert werden.

Berechtigungen: User-Managed Notebooks: - storage.buckets.writer: Muss dem Dienstkonto des Projekts zugewiesen werden, das an die VM angehängt ist. Google Managed Notebooks: - storage.buckets.writer: Muss dem Dienstkonto des Projekts oder den Nutzeranmeldedaten, die an die VM angehängt sind, je nach Authentifizierungsmodus zugewiesen werden.

Cloud Storage-Bucket: Logdatei wird in gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz geschrieben
relative_path

string

Optional. Definiert den relativen Speicherpfad im Cloud Storage-Bucket, in den die Diagnoselogs geschrieben werden. Der Standardpfad ist das Stammverzeichnis des Cloud Storage-Buckets (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Beispiel für den vollständigen Pfad, in den die Logdatei geschrieben wird: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

Optional. Aktiviert das Flag zum Reparieren des Dienstes für die Instanz.
enable_packet_capture_flag

bool

Optional. Aktiviert das Flag, um 30 Sekunden lang Pakete von der Instanz zu erfassen.
enable_copy_home_files_flag

bool

Optional. Ermöglicht das Kopieren aller Inhalte des Ordners /home/jupyter

DiskEncryption

Definition der Optionen für die Laufwerkverschlüsselung.

Enums
DISK_ENCRYPTION_UNSPECIFIED Die Festplattenverschlü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.

DiskType

Mögliche Laufwerkstypen.

Enums
DISK_TYPE_UNSPECIFIED Der Laufwerkstyp wurde nicht festgelegt.
PD_STANDARD Typ des nichtflüchtigen Standardspeichers.
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 nichtflüchtigen Speicher vom Typ „Hyperdisk ML“ dar. Kann als Bootlaufwerk oder Datenlaufwerk verwendet werden.

GPUDriverConfig

Eine GPU-Treiberkonfiguration

Felder
enable_gpu_driver

bool

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

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.

GceSetup

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

Felder
machine_type

string

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

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.
accelerator_configs[]

AcceleratorConfig

Optional. Die auf dieser Instanz verwendeten Hardwarebeschleuniger. Wenn Sie Beschleuniger verwenden, muss Ihre Konfiguration genügend vCPUs und Arbeitsspeicher zur Unterstützung der ausgewählten machine_type haben. Derzeit wird nur eine Beschleunigerkonfiguration unterstützt.
service_accounts[]

ServiceAccount

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

BootDisk

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

DataDisk

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

ShieldedInstanceConfig

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

NetworkInterface

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

bool

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

string

Optional. Die Compute Engine-Netzwerktags, die der Laufzeit hinzugefügt werden sollen (siehe Netzwerktags konfigurieren).
metadata

map<string, string>

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

bool

Optional. Flag zum Aktivieren oder Deaktivieren der IP-Weiterleitung. Standardmäßig ist es auf „false“ (aus) gesetzt. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

Optional. Konfiguration für GPU-Treiber.
confidential_instance_config

ConfidentialInstanceConfig

Optional. Konfiguration vertraulicher Instanzen.
instance_id

string

Nur Ausgabe. Die eindeutige ID der Compute Engine-Instanzressource.
Union-Feld image. Typ des Images; kann „VM-Image“ oder „Container-Image“ sein. Für image ist nur einer der folgenden Werte zulässig:
vm_image

VmImage

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

ContainerImage

Optional. Verwenden Sie ein Container-Image, um die Notebook-Instanz zu starten.

GetConfigRequest

Anfrage zum Abrufen von Workbench-Konfigurationsparametern.

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}

GetInstanceRequest

Anfrage zum Abrufen einer Notebook-Instanz.

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.get

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 „ACTIVE“.
AGENT_NOT_INSTALLED Auf der Instanz ist kein Agent zur 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.

ImageRelease

ConfigImage steht für einen Image-Release, der zum Erstellen einer WbI verfügbar ist.

Felder
image_name

string

Nur Ausgabe. Der Name des Image im Format workbench-instances-vYYYYmmdd--
release_name

string

Nur Ausgabe. Die Veröffentlichung des Bildes des Formulars m123

Instanz

Die Definition einer Notebook-Instanz.

Felder
name

string

Nur Ausgabe. ID. Der Name dieser Notebook-Instanz. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

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

string

Optional. Der Inhaber dieser Instanz nach der Erstellung. Format: alias@example.com

Derzeit wird nur ein Eigentümer 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 CreateInstance-Anfrage gesendet hat.
state

State

Nur Ausgabe. Der Status dieser Instanz.
upgrade_history[]

UpgradeHistoryEntry

Nur Ausgabe. Der Upgradeverlauf dieser Instanz.
id

string

Nur Ausgabe. Eindeutige ID der Ressource.
health_state

HealthState

Nur Ausgabe. health_state der Instanz.
health_info

map<string, string>

Nur Ausgabe. Zusätzliche Informationen zum Instanzzustand. 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"
}
create_time

Timestamp

Nur Ausgabe. Erstellungszeit der Instanz.
update_time

Timestamp

Nur Ausgabe. Zeitpunkt der Instanzaktualisierung.
disable_proxy_access

bool

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

map<string, string>

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

string

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

bool

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

bool

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

bool

Optional. Flag, das angibt, dass auf ein Notebook mit einem Drittanbieter-Identitätsanbieter zugegriffen werden kann.
enable_managed_euc

bool

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

bool

Optional. Wenn „true“, wird der Löschschutz für diese Workbench-Instanz aktiviert. Bei „false“ wird der Löschschutz für diese Workbench-Instanz deaktiviert.
Union-Feld infrastructure. Einrichtung für die Notebook-Instanz. Für infrastructure ist nur einer der folgenden Werte zulässig:
gce_setup

GceSetup

Optional. Compute Engine-Einrichtung für das Notebook. Verwendet im Notebook definierte Felder.

ListInstancesRequest

Anfrage zum Auflisten von Notebook-Instanzen.

Felder
parent

string

Erforderlich. Das übergeordnete Element der Instanz. Formate: - projects/{project_id}/locations/{location}, um Instanzen in einer bestimmten Zone aufzulisten. – projects/{project_id}/locations/-, um Instanzen an allen Standorten aufzulisten.

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent:

  • notebooks.instances.list
page_size

int32

Optional. Maximale Rückgabegröße des Listenaufrufs.
page_token

string

Optional. Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.
order_by

string

Optional. Ergebnisse sortieren. Unterstützte Werte sind "name", "name desc" oder "" (nicht sortiert).
filter

string

Optional. Listenfilter

ListInstancesResponse

Antwort für das Auflisten von Notebook-Instanzen.

Felder
instances[]

Instance

Eine Liste der zurückgegebenen Instanzen.
next_page_token

string

Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis im nächsten Listenaufruf fortzusetzen.
unreachable[]

string

Unsortierte Liste. Standorte, die nicht erreicht werden konnten. Beispiel: ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Eine ListInstancesResponse enthält entweder Instanzen oder nicht erreichbare Instanzen.

NetworkInterface

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

Felder
network

string

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

string

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

NicType

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

AccessConfig

Optional. Ein Array mit 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.

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

OperationMetadata

Stellt die Metadaten des Vorgangs mit langer Ausführungszeit dar.

Felder
create_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang erstellt wurde.
end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
target

string

Serverdefinierter Ressourcenpfad für das Ziel des Vorgangs.
verb

string

Name des vom Vorgang ausgeführten Verbs.
status_message

string

Lesbarer Status des Vorgangs, falls vorhanden.
requested_cancellation

bool

Gibt an, ob der Nutzer einen Abbruch angefordert hat. Vorgänge, die erfolgreich abgebrochen wurden, haben den Wert google.longrunning.Operation.error mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.
api_version

string

Zum Starten des Vorgangs verwendete API-Version.
endpoint

string

API-Endpunktname dieses Vorgangs.

ResetInstanceRequest

Zurücksetzung einer Notebook-Instanz anfordern

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.reset

ResizeDiskRequest

Größenanpassung der Notebook-Instanzlaufwerke anfordern

Felder
notebook_instance

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource notebookInstance:

  • notebooks.instances.update
Union-Feld Disk. Typ des Laufwerks, dessen Größe geändert werden kann: Boot- oder Datenlaufwerk Disk kann nur einer der folgenden Werte sein:
boot_disk

BootDisk

Erforderlich. Das Bootlaufwerk, dessen Größe geändert werden soll. Es wird nur „disk_size_gb“ verwendet.
data_disk

DataDisk

Erforderlich. Das Laufwerk, dessen Größe angepasst werden soll. Es wird nur „disk_size_gb“ verwendet.

RestoreInstanceRequest

Anfrage zum Wiederherstellen der Notebook-Instanz aus einer BackupSource.

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.update
Union-Feld Source. Die Quelle, aus der wiederhergestellt werden soll. Für Source ist nur einer der folgenden Werte zulässig:
snapshot

Snapshot

Der Snapshot, der für die Wiederherstellung verwendet werden soll.

RollbackInstanceRequest

Rollback für eine Notebookinstanz anfordern

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.rollback
target_snapshot

string

Erforderlich. Der Snapshot für den Rollback. Beispiel: „projects/test-project/global/snapshots/krwlzipynril“
revision_id

string

Erforderlich. Nur Ausgabe. Versions-ID

ServiceAccount

Ein Dienstkonto, das als Identität fungiert.

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. Vom CLH auf https://www.googleapis.com/auth/cloud-platform festgelegt

ShieldedInstanceConfig

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

Felder
enable_secure_boot

bool

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

bool

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

bool

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

Ermöglicht das Monitoring und die Attestierung der Boot-Integrität der VM-Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Referenz wird bei der Erstellung der VM-Instanz vom Boot-Image abgeleitet, dem implizit vertraut wird.

Snapshot

„Snapshot“ steht für den Snapshot des Datenträgers, der zum Wiederherstellen der Workbench-Instanz verwendet wurde. Verweist auf: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Felder
snapshot_id

string

Erforderlich. Die ID des Snapshots.
project_id

string

Erforderlich. Die Projekt-ID des Snapshots.

StartInstanceRequest

Anfrage zum Starten einer Notebookinstanz

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.start

Bundesland

Die Definition der Status 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 gesperrt.
SUSPENDED Die Instanz wurde gesperrt.

StopInstanceRequest

Anfrage zum Beenden einer Notebookinstanz

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.stop

SupportedValues

„SupportedValues“ steht für die von der Konfiguration unterstützten Werte.

Felder
machine_types[]

string

Nur Ausgabe. Die von WbI unterstützten Maschinentypen.
accelerator_types[]

string

Nur Ausgabe. Die von WbI unterstützten Beschleunigertypen.

UpdateInstanceRequest

Anfrage zum Aktualisieren einer Notebook-Instanz

Felder
instance

Instance

Erforderlich. Eine Darstellung einer Instanz.

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource instance:

  • iam.permissions.none
update_mask

FieldMask

Erforderlich. Maske zum Aktualisieren einer Instanz. Aktualisierbare Felder:

  • labels
  • gce_setup.min_cpu_platform
  • gce_setup.metadata
  • gce_setup.machine_type
  • gce_setup.accelerator_configs
  • gce_setup.accelerator_configs.type
  • gce_setup.accelerator_configs.core_count
  • gce_setup.gpu_driver_config
  • gce_setup.gpu_driver_config.enable_gpu_driver
  • gce_setup.gpu_driver_config.custom_gpu_driver_path
  • gce_setup.shielded_instance_config
  • gce_setup.shielded_instance_config.enable_secure_boot
  • gce_setup.shielded_instance_config.enable_vtpm
  • gce_setup.shielded_instance_config.enable_integrity_monitoring
  • gce_setup.reservation_affinity
  • gce_setup.reservation_affinity.consume_reservation_type
  • gce_setup.reservation_affinity.key
  • gce_setup.reservation_affinity.values
  • gce_setup.tags
  • gce_setup.container_image
  • gce_setup.container_image.repository
  • gce_setup.container_image.tag
  • gce_setup.disable_public_ip
  • disable_proxy_access
request_id

string

Optional. UUID für idempotente Anfrage.

UpgradeHistoryEntry

Der Eintrag des VM-Image-Upgradeverlaufs.

Felder
snapshot

string

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

string

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

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

State

Nur Ausgabe. Der Status dieses Eintrags im Verlauf der Instanzupgrades.
create_time

Timestamp

Nicht veränderbar. Der Zeitpunkt, zu dem dieser Eintrag im Verlauf der Instanzupgrades erstellt wurde.
action

Action

Optional. Aktion Rollback oder Upgrade.
target_version

string

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

Aktion

Die Definition der Vorgänge dieses Upgradeverlaufs.

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

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 erfolgreich durchgeführt.
FAILED Das Instanzupgrade ist fehlgeschlagen.

UpgradeInstanceRequest

Anfrage zum Aktualisieren einer Notebook-Instanz

Felder
name

string

Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.upgrade

VmImage

Definition eines benutzerdefinierten Compute Engine-Images für virtuelle Maschinen zum Starten einer Notebook-Instanz, auf der die Umgebung direkt auf der VM installiert ist.

Felder
project

string

Erforderlich. Der Name des Google Cloud-Projekts, zu dem dieses VM-Image gehört. Format: {project_id}
Union-Feld image. Der Verweis auf ein externes Compute Engine-VM-Image. Für image ist nur einer der folgenden Werte zulässig:
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.