Notebooks API

Mit der Notebooks API können Sie Agent Platform Workbench-Ressourcen in Google Cloud verwalten.

Dienst: notebooks.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente bereitstellen. Dieser Dienst stellt folgende Discovery-Dokumente bereit:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://notebooks.googleapis.com

REST-Ressource: v2.projects.locations

Methoden
get GET /v2/{name}
Ruft Informationen zu einer Zone ab.
list GET /v2/{name}/locations
Listet Informationen zu den unterstützten Zonen für diesen Dienst auf.

REST-Ressource: v2.projects.locations.instances

Methoden
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Prüft, ob eine Notebook-Instanz aktualisiert werden kann.
create POST /v2/{parent}/instances
Erstellt eine neue Instanz in einem angegebenen Projekt und an einem angegebenen Ort.
delete DELETE /v2/{name}
Löscht eine einzelne Instanz.
diagnose POST /v2/{name}:diagnose
Erstellt eine Diagnosedatei und führt das Diagnosetool für eine Instanz aus.
get GET /v2/{name}
Ruft Details zu einer einzelnen Instanz ab.
getConfig GET /v2/{name}/instances:getConfig
Gibt verschiedene Konfigurationsparameter zurück.
getIamPolicy GET /v2/{resource}:getIamPolicy
Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.
list GET /v2/{parent}/instances
Listet Instanzen in einem angegebenen Projekt und an einem angegebenen Standort auf.
patch PATCH /v2/{instance.name}
Mit UpdateInstance wird eine Instanz aktualisiert.
reset POST /v2/{name}:reset
Setzt eine Notebook-Instanz zurück.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Größe des Laufwerks einer Notebook-Instanz auf eine höhere Kapazität ändern.
restore POST /v2/{name}:restore
Mit RestoreInstance wird eine Instanz aus einer BackupSource wiederhergestellt.
rollback POST /v2/{name}:rollback
Führt ein Rollback einer Notebook-Instanz auf die vorherige Version durch.
setIamPolicy POST /v2/{resource}:setIamPolicy
Legt die Richtlinie für die Zugriffssteuerung für die angegebene Ressource fest.
start POST /v2/{name}:start
Startet eine Notebook-Instanz.
stop POST /v2/{name}:stop
Beendet eine Notebookinstanz.
testIamPermissions POST /v2/{resource}:testIamPermissions
Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.
upgrade POST /v2/{name}:upgrade
Aktualisiert eine Notebook-Instanz auf die neueste Version.

REST-Ressource: v2.projects.locations.operations

Methoden
cancel POST /v2/{name}:cancel
Startet den asynchronen Abbruch eines Vorgangs mit langer Ausführungszeit.
delete DELETE /v2/{name}
Löscht einen Vorgang mit langer Ausführungszeit.
get GET /v2/{name}
Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit ab.
list GET /v2/{name}/operations
Listet Vorgänge auf, die zu dem angegebenen Filter in der Anfrage passen.

REST-Ressource: v1.projects.locations

Methoden
get GET /v1/{name}
Ruft Informationen zu einer Zone ab.
list GET /v1/{name}/locations
Listet Informationen zu den unterstützten Zonen für diesen Dienst auf.

REST-Ressource: v1.projects.locations.environments

Methoden
create POST /v1/{parent}/environments
Erstellt eine neue Umgebung.
delete DELETE /v1/{name}
Löscht eine einzelne Umgebung.
get GET /v1/{name}
Ruft Details zu einer einzelnen Umgebung ab.
list GET /v1/{parent}/environments
Listet Umgebungen in einem Projekt auf.

REST-Ressource: v1.projects.locations.executions

Methoden
create POST /v1/{parent}/executions
Erstellt eine neue Ausführung in einem bestimmten Projekt und an einem bestimmten Standort.
delete DELETE /v1/{name}
Löscht die Ausführung
get GET /v1/{name}
Ruft Details zu Ausführungen ab.
list GET /v1/{parent}/executions
Listet Ausführungen in einem bestimmten Projekt und an einem bestimmten Standort auf

REST-Ressource: v1.projects.locations.instances

Methoden
create POST /v1/{parent}/instances
Erstellt eine neue Instanz in einem angegebenen Projekt und an einem angegebenen Ort.
delete DELETE /v1/{name}
Löscht eine einzelne Instanz.
diagnose POST /v1/{name}:diagnose
Erstellt eine Diagnosedatei und führt das Diagnosetool für eine Instanz aus.
get GET /v1/{name}
Ruft Details zu einer einzelnen Instanz ab.
getIamPolicy GET /v1/{resource}:getIamPolicy
Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Prüft, ob eine Notebook-Instanz fehlerfrei ist.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Prüft, ob eine Notebook-Instanz aktualisiert werden kann.
list GET /v1/{parent}/instances
Listet Instanzen in einem angegebenen Projekt und an einem angegebenen Standort auf.
migrate POST /v1/{name}:migrate
Migriert ein vorhandenes nutzerverwaltetes Notebook zu Workbench-Instanzen.
register POST /v1/{parent}/instances:register
Registriert eine vorhandene Legacy-Notebookinstanz beim Notebooks API-Server.
report POST /v1/{name}:report
Ermöglicht Notebook-Instanzen, ihre neuesten Instanzinformationen an den Notebooks API-Server zu senden.
reset POST /v1/{name}:reset
Setzt eine Notebook-Instanz zurück.
rollback POST /v1/{name}:rollback
Führt ein Rollback einer Notebook-Instanz auf die vorherige Version durch.
setAccelerator PATCH /v1/{name}:setAccelerator
Aktualisiert die Gastbeschleuniger einer einzelnen Instanz.
setIamPolicy POST /v1/{resource}:setIamPolicy
Legt die Richtlinie für die Zugriffssteuerung für die angegebene Ressource fest.
setLabels PATCH /v1/{name}:setLabels
Ersetzt alle Labels einer Instanz.
setMachineType PATCH /v1/{name}:setMachineType
Aktualisiert den Maschinentyp einer einzelnen Instanz.
start POST /v1/{name}:start
Startet eine Notebook-Instanz.
stop POST /v1/{name}:stop
Beendet eine Notebookinstanz.
testIamPermissions POST /v1/{resource}:testIamPermissions
Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.
updateConfig PATCH /v1/{name}:updateConfig
Notebook-Instanzkonfigurationen aktualisieren.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Metadatenelemente für eine Instanz hinzufügen oder aktualisieren.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Aktualisiert die Konfiguration der abgeschirmten Instanz einer einzelnen Instanz.
upgrade POST /v1/{name}:upgrade
Aktualisiert eine Notebook-Instanz auf die neueste Version.

REST-Ressource: v1.projects.locations.operations

Methoden
cancel POST /v1/{name}:cancel
Startet den asynchronen Abbruch eines Vorgangs mit langer Ausführungszeit.
delete DELETE /v1/{name}
Löscht einen Vorgang mit langer Ausführungszeit.
get GET /v1/{name}
Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit ab.
list GET /v1/{name}/operations
Listet Vorgänge auf, die zu dem angegebenen Filter in der Anfrage passen.

REST-Ressource: v1.projects.locations.runtimes

Methoden
create POST /v1/{parent}/runtimes
Erstellt eine neue Laufzeit in einem bestimmten Projekt und an einem bestimmten Standort.
delete DELETE /v1/{name}
Löscht eine einzelne Laufzeit.
get GET /v1/{name}
Ruft Details zu einer einzelnen Laufzeit ab.
getIamPolicy GET /v1/{resource}:getIamPolicy
Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.
list GET /v1/{parent}/runtimes
Listet Runtimes in einem bestimmten Projekt und an einem bestimmten Standort auf.
migrate POST /v1/{name}:migrate
Vorhandene Laufzeit zu einer neuen Workbench-Instanz migrieren.
patch PATCH /v1/{runtime.name}
Aktualisieren Sie die Notebook-Laufzeitkonfiguration.
reportEvent POST /v1/{name}:reportEvent
Meldet und verarbeitet ein Laufzeitereignis.
reset POST /v1/{name}:reset
Setzt eine verwaltete Notebook-Laufzeit zurück.
setIamPolicy POST /v1/{resource}:setIamPolicy
Legt die Richtlinie für die Zugriffssteuerung für die angegebene Ressource fest.
start POST /v1/{name}:start
Startet eine verwaltete Notebook-Laufzeit.
stop POST /v1/{name}:stop
Beendet eine verwaltete Notebook-Laufzeit.
switch POST /v1/{name}:switch
Verwaltete Notebook-Laufzeit wechseln.
testIamPermissions POST /v1/{resource}:testIamPermissions
Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.

REST-Ressource: v1.projects.locations.schedules

Methoden
create POST /v1/{parent}/schedules
Erstellt ein neues geplantes Notebook in einem bestimmten Projekt und an einem bestimmten Standort.
delete DELETE /v1/{name}
Löscht den Zeitplan und alle zugrunde liegenden Jobs.
get GET /v1/{name}
Ruft Details zum Zeitplan ab.
list GET /v1/{parent}/schedules
Listet Zeitpläne in einem bestimmten Projekt und an einem bestimmten Standort auf.