Notebooks API

L'API Notebooks vous permet de gérer les ressources Agent Platform Workbench dans Google Cloud.

Service : notebooks.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, conformez-vous aux informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification exploitable par un ordinateur qui permet de décrire et de consommer les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit les documents de découverte suivants :

Point de terminaison de service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://notebooks.googleapis.com

Ressource REST : v2.projects.locations

Méthodes
get GET /v2/{name}
Récupère les informations concernant un emplacement.
list GET /v2/{name}/locations
Répertorie les informations concernant les emplacements compatibles avec ce service.

Ressource REST : v2.projects.locations.instances

Méthodes
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Vérifie si une instance de notebook peut être mise à niveau.
create POST /v2/{parent}/instances
Crée une instance dans un projet et un emplacement donnés.
delete DELETE /v2/{name}
Supprime une seule instance.
diagnose POST /v2/{name}:diagnose
Crée un fichier de diagnostic et exécute l'outil de diagnostic pour une instance donnée.
get GET /v2/{name}
Récupère les informations concernant une seule instance.
getConfig GET /v2/{name}/instances:getConfig
Renvoie différents paramètres de configuration.
getIamPolicy GET /v2/{resource}:getIamPolicy
Récupère la stratégie de contrôle d'accès d'une ressource.
list GET /v2/{parent}/instances
Liste les instances d'un projet et d'un emplacement donnés.
patch PATCH /v2/{instance.name}
UpdateInstance met à jour une instance.
reset POST /v2/{name}:reset
Réinitialise une instance de notebook.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Redimensionnez le disque d'une instance de notebook pour augmenter sa capacité.
restore POST /v2/{name}:restore
RestoreInstance restaure une instance à partir d'une BackupSource.
rollback POST /v2/{name}:rollback
Restaure la version précédente d'une instance de notebook.
setIamPolicy POST /v2/{resource}:setIamPolicy
Définit la stratégie de contrôle d'accès de la ressource spécifiée.
start POST /v2/{name}:start
Démarre une instance de notebook.
stop POST /v2/{name}:stop
Arrête une instance de notebook.
testIamPermissions POST /v2/{resource}:testIamPermissions
Renvoie les autorisations dont dispose un appelant pour la ressource spécifiée.
upgrade POST /v2/{name}:upgrade
Mets à niveau une instance de notebook vers la dernière version.

Ressource REST : v2.projects.locations.operations

Méthodes
cancel POST /v2/{name}:cancel
Démarre l'annulation asynchrone sur une opération de longue durée.
delete DELETE /v2/{name}
Supprime une opération de longue durée.
get GET /v2/{name}
Récupère le dernier état d'une opération de longue durée.
list GET /v2/{name}/operations
Répertorie les opérations qui correspondent au filtre spécifié dans la requête.

Ressource REST : v1.projects.locations

Méthodes
get GET /v1/{name}
Récupère les informations concernant un emplacement.
list GET /v1/{name}/locations
Répertorie les informations concernant les emplacements compatibles avec ce service.

Ressource REST : v1.projects.locations.environments

Méthodes
create POST /v1/{parent}/environments
Crée un environnement.
delete DELETE /v1/{name}
Supprime un seul environnement.
get GET /v1/{name}
Récupère les détails d'un seul environnement.
list GET /v1/{parent}/environments
Répertorie les environnements d'un projet.

Ressource REST : v1.projects.locations.executions

Méthodes
create POST /v1/{parent}/executions
Crée une exécution dans un projet et un emplacement donnés.
delete DELETE /v1/{name}
Supprime l'exécution
get GET /v1/{name}
Obtient les détails des exécutions
list GET /v1/{parent}/executions
Liste les exécutions d'un projet et d'un emplacement donnés.

Ressource REST : v1.projects.locations.instances

Méthodes
create POST /v1/{parent}/instances
Crée une instance dans un projet et un emplacement donnés.
delete DELETE /v1/{name}
Supprime une seule instance.
diagnose POST /v1/{name}:diagnose
Crée un fichier de diagnostic et exécute l'outil de diagnostic pour une instance donnée.
get GET /v1/{name}
Récupère les informations concernant une seule instance.
getIamPolicy GET /v1/{resource}:getIamPolicy
Récupère la stratégie de contrôle d'accès d'une ressource.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Vérifie si une instance de notebook est opérationnelle.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Vérifie si une instance de notebook peut être mise à niveau.
list GET /v1/{parent}/instances
Liste les instances d'un projet et d'un emplacement donnés.
migrate POST /v1/{name}:migrate
Migre un notebook géré par l'utilisateur existant vers des instances Workbench.
register POST /v1/{parent}/instances:register
Enregistre une ancienne instance de notebook existante sur le serveur de l'API Notebooks.
report POST /v1/{name}:report
Permet aux instances de notebook de communiquer les dernières informations les concernant au serveur de l'API Notebooks.
reset POST /v1/{name}:reset
Réinitialise une instance de notebook.
rollback POST /v1/{name}:rollback
Restaure la version précédente d'une instance de notebook.
setAccelerator PATCH /v1/{name}:setAccelerator
Met à jour les accélérateurs invités d'une seule instance.
setIamPolicy POST /v1/{resource}:setIamPolicy
Définit la stratégie de contrôle d'accès de la ressource spécifiée.
setLabels PATCH /v1/{name}:setLabels
Remplace tous les libellés d'une instance.
setMachineType PATCH /v1/{name}:setMachineType
Met à jour le type de machine d'une seule instance.
start POST /v1/{name}:start
Démarre une instance de notebook.
stop POST /v1/{name}:stop
Arrête une instance de notebook.
testIamPermissions POST /v1/{resource}:testIamPermissions
Renvoie les autorisations dont dispose un appelant pour la ressource spécifiée.
updateConfig PATCH /v1/{name}:updateConfig
Mettez à jour les configurations de l'instance de notebook.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Ajoutez ou mettez à jour des éléments de métadonnées pour une instance.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Met à jour la configuration d'instance protégée d'une seule instance.
upgrade POST /v1/{name}:upgrade
Mets à niveau une instance de notebook vers la dernière version.

Ressource REST : v1.projects.locations.operations

Méthodes
cancel POST /v1/{name}:cancel
Démarre l'annulation asynchrone sur une opération de longue durée.
delete DELETE /v1/{name}
Supprime une opération de longue durée.
get GET /v1/{name}
Récupère le dernier état d'une opération de longue durée.
list GET /v1/{name}/operations
Répertorie les opérations qui correspondent au filtre spécifié dans la requête.

Ressource REST : v1.projects.locations.runtimes

Méthodes
create POST /v1/{parent}/runtimes
Crée un Runtime dans un projet et un emplacement donnés.
delete DELETE /v1/{name}
Supprime un seul Runtime.
get GET /v1/{name}
Récupère les détails d'un seul environnement d'exécution.
getIamPolicy GET /v1/{resource}:getIamPolicy
Récupère la stratégie de contrôle d'accès d'une ressource.
list GET /v1/{parent}/runtimes
Liste les runtimes d'un projet et d'un emplacement donnés.
migrate POST /v1/{name}:migrate
Migrer un environnement d'exécution existant vers une nouvelle instance Workbench.
patch PATCH /v1/{runtime.name}
Mettez à jour la configuration de l'environnement d'exécution de notebook.
reportEvent POST /v1/{name}:reportEvent
Signale et traite un événement d'exécution.
reset POST /v1/{name}:reset
Réinitialise un environnement d'exécution de notebooks gérés.
setIamPolicy POST /v1/{resource}:setIamPolicy
Définit la stratégie de contrôle d'accès de la ressource spécifiée.
start POST /v1/{name}:start
Démarre un environnement d'exécution de notebook géré.
stop POST /v1/{name}:stop
Arrête un environnement d'exécution de notebook géré.
switch POST /v1/{name}:switch
Basculer vers un environnement d'exécution de notebook géré.
testIamPermissions POST /v1/{resource}:testIamPermissions
Renvoie les autorisations dont dispose un appelant pour la ressource spécifiée.

Ressource REST : v1.projects.locations.schedules

Méthodes
create POST /v1/{parent}/schedules
Crée un notebook planifié dans un projet et un emplacement donnés.
delete DELETE /v1/{name}
Supprime la programmation et tous les jobs sous-jacents
get GET /v1/{name}
Obtient les détails d'une programmation.
list GET /v1/{parent}/schedules
Liste les plannings d'un projet et d'un emplacement donnés.