Notebooks API

L'API Notebooks ti consente di gestire le risorse di Agent Platform Workbench in Google Cloud.

Servizio: notebooks.googleapis.com

Per chiamare questo servizio, ti consigliamo di utilizzare le librerie client fornite da Google. Se la tua applicazione deve utilizzare le tue librerie per chiamare questo servizio, utilizza le seguenti informazioni quando effettui le richieste API.

Documento di rilevamento

Un documento di rilevamento è una specifica leggibile da una macchina per descrivere e utilizzare le API REST. Viene utilizzato per creare librerie client, plug-in IDE e altri strumenti che interagiscono con le API di Google. Un servizio può fornire più documenti di rilevamento. Questo servizio fornisce i seguenti documenti di rilevamento:

Endpoint di servizio

Un endpoint di servizio è un URL di base che specifica l'indirizzo di rete di un servizio API. Un servizio potrebbe avere più endpoint di servizio. Questo servizio ha il seguente endpoint di servizio e tutti gli URI riportati di seguito sono relativi a questo endpoint di servizio:

  • https://notebooks.googleapis.com

Risorsa REST: v2.projects.locations

Metodi
get GET /v2/{name}
Recupera informazioni su una località.
list GET /v2/{name}/locations
Elenca le informazioni sulle località supportate per questo servizio.

Risorsa REST: v2.projects.locations.instances

Metodi
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Controlla se è possibile eseguire l'upgrade di un'istanza notebook.
create POST /v2/{parent}/instances
Crea una nuova istanza in un progetto e una località specifici.
delete DELETE /v2/{name}
Elimina una singola istanza.
diagnose POST /v2/{name}:diagnose
Crea un file di diagnostica ed esegue lo strumento di diagnostica per una determinata istanza.
get GET /v2/{name}
Recupera i dettagli di una singola istanza.
getConfig GET /v2/{name}/instances:getConfig
Restituisce vari parametri di configurazione.
getIamPolicy GET /v2/{resource}:getIamPolicy
Recupera la policy di controllo dell'accesso per una risorsa.
list GET /v2/{parent}/instances
Elenca le istanze in un progetto e una località specifici.
patch PATCH /v2/{instance.name}
UpdateInstance aggiorna un'istanza.
reset POST /v2/{name}:reset
Reimposta un'istanza notebook.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Ridimensiona un disco dell'istanza notebook a una capacità superiore.
restore POST /v2/{name}:restore
RestoreInstance ripristina un'istanza da un'origine di backup.
rollback POST /v2/{name}:rollback
Esegue il rollback di un'istanza di notebook alla versione precedente.
setIamPolicy POST /v2/{resource}:setIamPolicy
Imposta la policy di controllo dell'accesso sulla risorsa specificata.
start POST /v2/{name}:start
Avvia un'istanza di notebook.
stop POST /v2/{name}:stop
Arresta un'istanza di notebook.
testIamPermissions POST /v2/{resource}:testIamPermissions
Restituisce le autorizzazioni di cui dispone un chiamante per la risorsa specificata.
upgrade POST /v2/{name}:upgrade
Esegue l'upgrade di un'istanza di notebook all'ultima versione.

Risorsa REST: v2.projects.locations.operations

Metodi
cancel POST /v2/{name}:cancel
Avvia l'annullamento asincrono di un'operazione a lunga esecuzione.
delete DELETE /v2/{name}
Elimina un'operazione a lunga esecuzione.
get GET /v2/{name}
Recupera l'ultimo stato di un'operazione a lunga esecuzione.
list GET /v2/{name}/operations
Elenca le operazioni che corrispondono al filtro specificato nella richiesta.

Risorsa REST: v1.projects.locations

Metodi
get GET /v1/{name}
Recupera informazioni su una località.
list GET /v1/{name}/locations
Elenca le informazioni sulle località supportate per questo servizio.

Risorsa REST: v1.projects.locations.environments

Metodi
create POST /v1/{parent}/environments
Crea un nuovo ambiente.
delete DELETE /v1/{name}
Elimina un singolo ambiente.
get GET /v1/{name}
Recupera i dettagli di un singolo ambiente.
list GET /v1/{parent}/environments
Elenca gli ambienti in un progetto.

Risorsa REST: v1.projects.locations.executions

Metodi
create POST /v1/{parent}/executions
Crea una nuova esecuzione in un progetto e una località specifici.
delete DELETE /v1/{name}
Elimina l'esecuzione
get GET /v1/{name}
Recupera i dettagli delle esecuzioni
list GET /v1/{parent}/executions
Elenca le esecuzioni in un progetto e una località specifici

Risorsa REST: v1.projects.locations.instances

Metodi
create POST /v1/{parent}/instances
Crea una nuova istanza in un progetto e una località specifici.
delete DELETE /v1/{name}
Elimina una singola istanza.
diagnose POST /v1/{name}:diagnose
Crea un file di diagnostica ed esegue lo strumento di diagnostica per una determinata istanza.
get GET /v1/{name}
Recupera i dettagli di una singola istanza.
getIamPolicy GET /v1/{resource}:getIamPolicy
Recupera la policy di controllo dell'accesso per una risorsa.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Verifica se un'istanza notebook è in stato integro.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Controlla se è possibile eseguire l'upgrade di un'istanza notebook.
list GET /v1/{parent}/instances
Elenca le istanze in un progetto e una località specifici.
migrate POST /v1/{name}:migrate
Esegue la migrazione di un notebook gestito dall'utente esistente alle istanze di Workbench.
register POST /v1/{parent}/instances:register
Registra un'istanza notebook legacy esistente sul server API Notebooks.
report POST /v1/{name}:report
Consente alle istanze notebook di inviare le informazioni più recenti sull'istanza al server API Notebooks.
reset POST /v1/{name}:reset
Reimposta un'istanza notebook.
rollback POST /v1/{name}:rollback
Esegue il rollback di un'istanza di notebook alla versione precedente.
setAccelerator PATCH /v1/{name}:setAccelerator
Aggiorna gli acceleratori guest di una singola istanza.
setIamPolicy POST /v1/{resource}:setIamPolicy
Imposta la policy di controllo dell'accesso sulla risorsa specificata.
setLabels PATCH /v1/{name}:setLabels
Sostituisce tutte le etichette di un'istanza.
setMachineType PATCH /v1/{name}:setMachineType
Aggiorna il tipo di macchina di una singola istanza.
start POST /v1/{name}:start
Avvia un'istanza di notebook.
stop POST /v1/{name}:stop
Arresta un'istanza di notebook.
testIamPermissions POST /v1/{resource}:testIamPermissions
Restituisce le autorizzazioni di cui dispone un chiamante per la risorsa specificata.
updateConfig PATCH /v1/{name}:updateConfig
Aggiorna le configurazioni dell'istanza notebook.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Aggiungi/aggiorna elementi di metadati per un'istanza.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Aggiorna la configurazione dell'istanza schermata di una singola istanza.
upgrade POST /v1/{name}:upgrade
Esegue l'upgrade di un'istanza di notebook all'ultima versione.

Risorsa REST: v1.projects.locations.operations

Metodi
cancel POST /v1/{name}:cancel
Avvia l'annullamento asincrono di un'operazione a lunga esecuzione.
delete DELETE /v1/{name}
Elimina un'operazione a lunga esecuzione.
get GET /v1/{name}
Recupera l'ultimo stato di un'operazione a lunga esecuzione.
list GET /v1/{name}/operations
Elenca le operazioni che corrispondono al filtro specificato nella richiesta.

Risorsa REST: v1.projects.locations.runtimes

Metodi
create POST /v1/{parent}/runtimes
Crea un nuovo runtime in un progetto e una località specifici.
delete DELETE /v1/{name}
Elimina un singolo runtime.
get GET /v1/{name}
Recupera i dettagli di un singolo runtime.
getIamPolicy GET /v1/{resource}:getIamPolicy
Recupera la policy di controllo dell'accesso per una risorsa.
list GET /v1/{parent}/runtimes
Elenca i runtime in un progetto e una località specifici.
migrate POST /v1/{name}:migrate
Esegui la migrazione di un runtime esistente a una nuova istanza Workbench.
patch PATCH /v1/{runtime.name}
Aggiorna la configurazione del runtime del notebook.
reportEvent POST /v1/{name}:reportEvent
Genera report ed elabora un evento di runtime.
reset POST /v1/{name}:reset
Reimposta il runtime di un notebook gestito.
setIamPolicy POST /v1/{resource}:setIamPolicy
Imposta la policy di controllo dell'accesso sulla risorsa specificata.
start POST /v1/{name}:start
Avvia un runtime di notebook gestito.
stop POST /v1/{name}:stop
Arresta un runtime del notebook gestito.
switch POST /v1/{name}:switch
Passa a un runtime del notebook gestito.
testIamPermissions POST /v1/{resource}:testIamPermissions
Restituisce le autorizzazioni di cui dispone un chiamante per la risorsa specificata.

Risorsa REST: v1.projects.locations.schedules

Metodi
create POST /v1/{parent}/schedules
Crea un nuovo notebook pianificato in un progetto e una località specifici.
delete DELETE /v1/{name}
Elimina la pianificazione e tutti i job sottostanti
get GET /v1/{name}
Recupera i dettagli della pianificazione
list GET /v1/{parent}/schedules
Elenca le pianificazioni in un progetto e una località specifici.