Notebooks API

La API de Notebooks te permite administrar recursos de Agent Platform Workbench en Google Cloud.

Servicio: notebooks.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información que se indica más abajo cuando realices las solicitudes a la API.

Documento de descubrimiento

Un documento de descubrimiento es una especificación legible por máquina para describir y consumir las APIs de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona los siguientes documentos de descubrimiento:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://notebooks.googleapis.com

Recurso de REST: v2.projects.locations

Métodos
get GET /v2/{name}
Obtiene información sobre una ubicación.
list GET /v2/{name}/locations
Enumera la información sobre las ubicaciones compatibles con este servicio.

Recurso de REST: v2.projects.locations.instances

Métodos
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Verifica si se puede actualizar una instancia de notebook.
create POST /v2/{parent}/instances
Crea una instancia nueva en un proyecto y una ubicación determinados.
delete DELETE /v2/{name}
Borra una instancia única.
diagnose POST /v2/{name}:diagnose
Crea un archivo de diagnóstico y ejecuta la herramienta de diagnóstico para una instancia determinada.
get GET /v2/{name}
Obtiene los detalles de una sola instancia.
getConfig GET /v2/{name}/instances:getConfig
Devuelve varios parámetros de configuración.
getIamPolicy GET /v2/{resource}:getIamPolicy
Obtiene la política de control de acceso de un recurso.
list GET /v2/{parent}/instances
Enumera instancias en una ubicación y un proyecto determinados.
patch PATCH /v2/{instance.name}
UpdateInstance actualiza una instancia.
reset POST /v2/{name}:reset
Restablece una instancia de notebook.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Cambia el tamaño del disco de una instancia de notebook a una capacidad mayor.
restore POST /v2/{name}:restore
RestoreInstance restablece una instancia a partir de un BackupSource.
rollback POST /v2/{name}:rollback
Revierte una instancia de notebook a la versión anterior.
setIamPolicy POST /v2/{resource}:setIamPolicy
Configura la política de control de acceso en el recurso especificado.
start POST /v2/{name}:start
Inicia una instancia de notebook.
stop POST /v2/{name}:stop
Detiene una instancia de notebook.
testIamPermissions POST /v2/{resource}:testIamPermissions
Muestra los permisos que tienen un emisor para un recurso específico.
upgrade POST /v2/{name}:upgrade
Actualiza una instancia de notebook a la versión más reciente.

Recurso de REST: v2.projects.locations.operations

Métodos
cancel POST /v2/{name}:cancel
Inicia la cancelación asíncrona de una operación de larga duración.
delete DELETE /v2/{name}
Borra una operación de larga duración.
get GET /v2/{name}
Obtiene el último estado de una operación de larga duración.
list GET /v2/{name}/operations
Enumera las operaciones que coinciden con el filtro especificado en la solicitud.

Recurso de REST: v1.projects.locations

Métodos
get GET /v1/{name}
Obtiene información sobre una ubicación.
list GET /v1/{name}/locations
Enumera la información sobre las ubicaciones compatibles con este servicio.

Recurso de REST: v1.projects.locations.environments

Métodos
create POST /v1/{parent}/environments
Crea un entorno nuevo.
delete DELETE /v1/{name}
Borra un solo entorno.
get GET /v1/{name}
Obtiene detalles de un solo entorno.
list GET /v1/{parent}/environments
Enumera los entornos de un proyecto.

Recurso de REST: v1.projects.locations.executions

Métodos
create POST /v1/{parent}/executions
Crea una nueva ejecución en un proyecto y una ubicación determinados.
delete DELETE /v1/{name}
Borra la ejecución
get GET /v1/{name}
Obtiene detalles de las ejecuciones
list GET /v1/{parent}/executions
Enumera las ejecuciones en una ubicación y un proyecto determinados.

Recurso de REST: v1.projects.locations.instances

Métodos
create POST /v1/{parent}/instances
Crea una instancia nueva en un proyecto y una ubicación determinados.
delete DELETE /v1/{name}
Borra una instancia única.
diagnose POST /v1/{name}:diagnose
Crea un archivo de diagnóstico y ejecuta la herramienta de diagnóstico para una instancia determinada.
get GET /v1/{name}
Obtiene los detalles de una sola instancia.
getIamPolicy GET /v1/{resource}:getIamPolicy
Obtiene la política de control de acceso de un recurso.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Verifica si una instancia de notebook está en buen estado.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Verifica si se puede actualizar una instancia de notebook.
list GET /v1/{parent}/instances
Enumera instancias en una ubicación y un proyecto determinados.
migrate POST /v1/{name}:migrate
Migra un notebook administrado por el usuario existente a instancias de Workbench.
register POST /v1/{parent}/instances:register
Registra una instancia de notebook heredada existente en el servidor de la API de Notebooks.
report POST /v1/{name}:report
Permite que las instancias de notebook informen su información más reciente al servidor de la API de Notebooks.
reset POST /v1/{name}:reset
Restablece una instancia de notebook.
rollback POST /v1/{name}:rollback
Revierte una instancia de notebook a la versión anterior.
setAccelerator PATCH /v1/{name}:setAccelerator
Actualiza los aceleradores de invitado de una sola instancia.
setIamPolicy POST /v1/{resource}:setIamPolicy
Configura la política de control de acceso en el recurso especificado.
setLabels PATCH /v1/{name}:setLabels
Reemplaza todas las etiquetas de una instancia.
setMachineType PATCH /v1/{name}:setMachineType
Actualiza el tipo de máquina de una sola instancia.
start POST /v1/{name}:start
Inicia una instancia de notebook.
stop POST /v1/{name}:stop
Detiene una instancia de notebook.
testIamPermissions POST /v1/{resource}:testIamPermissions
Muestra los permisos que tienen un emisor para un recurso específico.
updateConfig PATCH /v1/{name}:updateConfig
Actualiza la configuración de la instancia de Notebook.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Agrega o actualiza elementos de metadatos para una instancia.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Actualiza la configuración de la instancia protegida de una sola instancia.
upgrade POST /v1/{name}:upgrade
Actualiza una instancia de notebook a la versión más reciente.

Recurso de REST: v1.projects.locations.operations

Métodos
cancel POST /v1/{name}:cancel
Inicia la cancelación asíncrona de una operación de larga duración.
delete DELETE /v1/{name}
Borra una operación de larga duración.
get GET /v1/{name}
Obtiene el último estado de una operación de larga duración.
list GET /v1/{name}/operations
Enumera las operaciones que coinciden con el filtro especificado en la solicitud.

Recurso de REST: v1.projects.locations.runtimes

Métodos
create POST /v1/{parent}/runtimes
Crea un entorno de ejecución nuevo en un proyecto y una ubicación determinados.
delete DELETE /v1/{name}
Borra un solo entorno de ejecución.
get GET /v1/{name}
Obtiene detalles de un solo entorno de ejecución.
getIamPolicy GET /v1/{resource}:getIamPolicy
Obtiene la política de control de acceso de un recurso.
list GET /v1/{parent}/runtimes
Enumera tiempos de ejecución en una ubicación y un proyecto determinados.
migrate POST /v1/{name}:migrate
Migra un entorno de ejecución existente a una nueva instancia de Workbench.
patch PATCH /v1/{runtime.name}
Actualiza la configuración del entorno de ejecución del notebook.
reportEvent POST /v1/{name}:reportEvent
Informa y procesa un evento de tiempo de ejecución.
reset POST /v1/{name}:reset
Restablece un entorno de ejecución de notebook administrado.
setIamPolicy POST /v1/{resource}:setIamPolicy
Configura la política de control de acceso en el recurso especificado.
start POST /v1/{name}:start
Inicia un entorno de ejecución de notebook administrado.
stop POST /v1/{name}:stop
Detiene un entorno de ejecución de notebook administrado.
switch POST /v1/{name}:switch
Cambia un entorno de ejecución de notebook administrado.
testIamPermissions POST /v1/{resource}:testIamPermissions
Muestra los permisos que tienen un emisor para un recurso específico.

Recurso de REST: v1.projects.locations.schedules

Métodos
create POST /v1/{parent}/schedules
Crea un nuevo cuaderno programado en un proyecto y una ubicación determinados.
delete DELETE /v1/{name}
Borra la programación y todos los trabajos subyacentes.
get GET /v1/{name}
Obtiene detalles de la programación
list GET /v1/{parent}/schedules
Enumera programas en una ubicación y un proyecto determinados.