Notebooks API

A API Notebooks permite gerenciar recursos do Agent Platform Workbench no Google Cloud.

Serviço: notebooks.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso o aplicativo precise usar bibliotecas próprias para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://notebooks.googleapis.com

Recurso REST: v2.projects.locations

Métodos
get GET /v2/{name}
Extrai informações sobre um local.
list GET /v2/{name}/locations
Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v2.projects.locations.instances

Métodos
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Verifica se uma instância de notebook pode ser atualizada.
create POST /v2/{parent}/instances
Cria uma nova instância em um determinado projeto e local.
delete DELETE /v2/{name}
Exclui uma única instância.
diagnose POST /v2/{name}:diagnose
Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico em uma determinada instância.
get GET /v2/{name}
Recebe detalhes de uma única instância.
getConfig GET /v2/{name}/instances:getConfig
Retorna vários parâmetros de configuração.
getIamPolicy GET /v2/{resource}:getIamPolicy
Busca a política de controle de acesso de um recurso.
list GET /v2/{parent}/instances
Lista as instâncias em um determinado projeto e local.
patch PATCH /v2/{instance.name}
O UpdateInstance atualiza uma instância.
reset POST /v2/{name}:reset
Redefine uma instância de notebook.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Redimensione o disco de uma instância de notebook para uma capacidade maior.
restore POST /v2/{name}:restore
"RestoreInstance" restaura uma instância de um "BackupSource".
rollback POST /v2/{name}:rollback
Reverte uma instância de notebook para a versão anterior.
setIamPolicy POST /v2/{resource}:setIamPolicy
Define a política de controle de acesso no recurso especificado.
start POST /v2/{name}:start
Inicia uma instância de notebook.
stop POST /v2/{name}:stop
Interrompe uma instância de notebook.
testIamPermissions POST /v2/{resource}:testIamPermissions
Retorna as permissões do autor da chamada no recurso especificado.
upgrade POST /v2/{name}:upgrade
Faz upgrade de uma instância de notebook para a versão mais recente.

Recurso REST: v2.projects.locations.operations

Métodos
cancel POST /v2/{name}:cancel
Inicia o cancelamento assíncrono em uma operação de longa duração.
delete DELETE /v2/{name}
Exclui uma operação de longa duração.
get GET /v2/{name}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v2/{name}/operations
Lista as operações correspondentes ao filtro especificado na solicitação.

Recurso REST: v1.projects.locations

Métodos
get GET /v1/{name}
Extrai informações sobre um local.
list GET /v1/{name}/locations
Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v1.projects.locations.environments

Métodos
create POST /v1/{parent}/environments
Cria um novo ambiente.
delete DELETE /v1/{name}
Exclui um único ambiente.
get GET /v1/{name}
Recebe detalhes de um único ambiente.
list GET /v1/{parent}/environments
Lista os ambientes em um projeto.

Recurso REST: v1.projects.locations.executions

Métodos
create POST /v1/{parent}/executions
Cria uma nova execução em determinado projeto e local.
delete DELETE /v1/{name}
Exclui a execução
get GET /v1/{name}
Recebe detalhes das execuções.
list GET /v1/{parent}/executions
Lista as execuções em um determinado projeto e local.

Recurso REST: v1.projects.locations.instances

Métodos
create POST /v1/{parent}/instances
Cria uma nova instância em um determinado projeto e local.
delete DELETE /v1/{name}
Exclui uma única instância.
diagnose POST /v1/{name}:diagnose
Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico em uma determinada instância.
get GET /v1/{name}
Recebe detalhes de uma única instância.
getIamPolicy GET /v1/{resource}:getIamPolicy
Busca a política de controle de acesso de um recurso.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Verifica se uma instância de notebook está íntegra.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Verifica se uma instância de notebook pode ser atualizada.
list GET /v1/{parent}/instances
Lista as instâncias em um determinado projeto e local.
migrate POST /v1/{name}:migrate
Migra um notebook gerenciado pelo usuário para instâncias do Workbench.
register POST /v1/{parent}/instances:register
Registra uma instância de notebook legada no servidor da API Notebooks.
report POST /v1/{name}:report
Permite que as instâncias de notebook informem as informações mais recentes da instância ao servidor da API Notebooks.
reset POST /v1/{name}:reset
Redefine uma instância de notebook.
rollback POST /v1/{name}:rollback
Reverte uma instância de notebook para a versão anterior.
setAccelerator PATCH /v1/{name}:setAccelerator
Atualiza os aceleradores convidados de uma única instância.
setIamPolicy POST /v1/{resource}:setIamPolicy
Define a política de controle de acesso no recurso especificado.
setLabels PATCH /v1/{name}:setLabels
Substitui todos os rótulos de uma instância.
setMachineType PATCH /v1/{name}:setMachineType
Atualiza o tipo de máquina de uma única instância.
start POST /v1/{name}:start
Inicia uma instância de notebook.
stop POST /v1/{name}:stop
Interrompe uma instância de notebook.
testIamPermissions POST /v1/{resource}:testIamPermissions
Retorna as permissões do autor da chamada no recurso especificado.
updateConfig PATCH /v1/{name}:updateConfig
Atualize as configurações da instância de notebook.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Adiciona/atualiza itens de metadados para uma instância.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Atualiza a configuração de instância protegida de uma única instância.
upgrade POST /v1/{name}:upgrade
Faz upgrade de uma instância de notebook para a versão mais recente.

Recurso da REST: v1.projects.locations.operations

Métodos
cancel POST /v1/{name}:cancel
Inicia o cancelamento assíncrono em uma operação de longa duração.
delete DELETE /v1/{name}
Exclui uma operação de longa duração.
get GET /v1/{name}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v1/{name}/operations
Lista as operações correspondentes ao filtro especificado na solicitação.

Recurso REST: v1.projects.locations.runtimes

Métodos
create POST /v1/{parent}/runtimes
Cria um novo ambiente de execução em determinado projeto e local.
delete DELETE /v1/{name}
Exclui um único ambiente de execução.
get GET /v1/{name}
Recebe detalhes de um único ambiente de execução.
getIamPolicy GET /v1/{resource}:getIamPolicy
Busca a política de controle de acesso de um recurso.
list GET /v1/{parent}/runtimes
Lista os runtimes em um determinado projeto e local.
migrate POST /v1/{name}:migrate
Migre um ambiente de execução para uma nova instância do Workbench.
patch PATCH /v1/{runtime.name}
Atualiza a configuração do ambiente de execução do notebook.
reportEvent POST /v1/{name}:reportEvent
Gera relatórios e processa um evento de tempo de execução.
reset POST /v1/{name}:reset
Redefine um ambiente de execução de notebook gerenciado.
setIamPolicy POST /v1/{resource}:setIamPolicy
Define a política de controle de acesso no recurso especificado.
start POST /v1/{name}:start
Inicia um ambiente de execução de notebook gerenciado.
stop POST /v1/{name}:stop
Interrompe um ambiente de execução de notebook gerenciado.
switch POST /v1/{name}:switch
Mude um ambiente de execução de notebook gerenciado.
testIamPermissions POST /v1/{resource}:testIamPermissions
Retorna as permissões do autor da chamada no recurso especificado.

Recurso REST: v1.projects.locations.schedules

Métodos
create POST /v1/{parent}/schedules
Cria um notebook programado em determinado projeto e local.
delete DELETE /v1/{name}
Exclui a programação e todos os jobs subjacentes.
get GET /v1/{name}
Recebe detalhes da programação
list GET /v1/{parent}/schedules
Lista os programações em um determinado projeto e local.