REST Resource: projects.locations.instances

Recurso: instância

A definição de uma instância de notebook.

Representação JSON 
{
  "name": string,
  "postStartupScript": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "serviceAccount": string,
  "serviceAccountScopes": [
    string
  ],
  "machineType": string,
  "acceleratorConfig": {
    object (AcceleratorConfig)
  },
  "state": enum (State),
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "bootDiskType": enum (DiskType),
  "bootDiskSizeGb": string,
  "dataDiskType": enum (DiskType),
  "dataDiskSizeGb": string,
  "noRemoveDataDisk": boolean,
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "disks": [
    {
      object (Disk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "noPublicIp": boolean,
  "noProxyAccess": boolean,
  "network": string,
  "subnet": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "tags": [
    string
  ],
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "nicType": enum (NicType),
  "reservationAffinity": {
    object (ReservationAffinity)
  },
  "creator": string,
  "canIpForward": boolean,
  "createTime": string,
  "updateTime": string,
  "instanceMigrationEligibility": {
    object (InstanceMigrationEligibility)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of mutually exclusive fields.
  "migrated": boolean
}
Campos
name

string

Apenas saída. O nome desta instância de notebook. Formato: projects/{projectId}/locations/{location}/instances/{instanceId}
postStartupScript

string

Caminho para um script Bash executado automaticamente após a inicialização completa de uma instância de notebook. O caminho precisa ser um URL ou do Cloud Storage (gs://path-to-file/file-name).
proxyUri

string

Apenas saída. O endpoint de proxy usado para acessar o notebook Jupyter.
instanceOwners[]

string

Somente entrada. O proprietário dessa instância após a criação. Formato: alias@example.com

No momento, só há suporte para um proprietário. Se não for especificado, todos os usuários da conta de serviço da instância de VM poderão usar a instância.
serviceAccount

string

A conta de serviço nessa instância, que dá acesso a outros serviços do Google Cloud. É possível usar qualquer conta de serviço no mesmo projeto, mas você precisa ter a permissão de usuário da conta de serviço para usar a instância.

Se não for especificada, a conta de serviço padrão do Compute Engine será usada.
serviceAccountScopes[]

string

Opcional. Os URIs dos escopos de conta de serviço a serem incluídos nas instâncias do Compute Engine.

Se não forem especificados, os seguintes escopos serão definidos: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Se você não estiver usando os escopos padrão, precisará de pelo menos: https://www.googleapis.com/auth/compute
machineType

string

Obrigatório. O tipo de máquina do Compute Engine desta instância.
acceleratorConfig

object (AcceleratorConfig)

O acelerador de hardware usado nesta instância. Se você usar aceleradores, verifique se a configuração tem vCPUs e memória suficientes para oferecer suporte ao machineType selecionado.
state

enum (State)

Apenas saída. O estado desta instância.
installGpuDriver

boolean

Se o usuário final autoriza o Google Cloud a instalar o driver de GPU nessa instância. Se esse campo estiver vazio ou definido como "false", o driver de GPU não será instalado. Aplicável apenas a instâncias com GPUs.
customGpuDriverPath

string

Especifique um caminho personalizado do Cloud Storage em que o driver de GPU está armazenado. Se não for especificado, vamos escolher automaticamente entre os drivers oficiais de GPU.
bootDiskType

enum (DiskType)

Somente entrada. O tipo do disco de inicialização anexado a esta instância, que tem como padrão o disco permanente padrão (PD_STANDARD).
bootDiskSizeGb

string (int64 format)

Somente entrada. O tamanho do disco de inicialização em GB anexado a esta instância, até um máximo de 64.000 GB (64 TB). O valor mínimo recomendado é 100 GB. Se não for especificado, o padrão será 100.
dataDiskType

enum (DiskType)

Somente entrada. O tipo de disco de dados anexado a esta instância, que tem como padrão o disco permanente padrão (PD_STANDARD).
dataDiskSizeGb

string (int64 format)

Somente entrada. O tamanho do disco de dados em GB anexado a esta instância, até um máximo de 64.000 GB (64 TB). Você pode escolher o tamanho do disco de dados com base no tamanho dos notebooks e dos dados. Se não for especificado, o padrão será 100.
noRemoveDataDisk

boolean

Somente entrada. Se for "true", o disco de dados não será excluído automaticamente ao excluir a instância.
diskEncryption

enum (DiskEncryption)

Somente entrada. Método de criptografia de disco usado nos discos de inicialização e de dados. O padrão é GMEK.
kmsKey

string

Somente entrada. A chave do KMS usada para criptografar os discos. Só é aplicável se diskEncryption for CMEK. Formato: projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Saiba mais sobre como usar suas próprias chaves de criptografia.
disks[]

object (Disk)

Apenas saída. Discos anexados à instância de notebook.
shieldedInstanceConfig

object (ShieldedInstanceConfig)

Opcional. Configuração de VM protegida. Imagens que usam recursos compatíveis de VM protegida.
noPublicIp

boolean

Se for "true", nenhum IP externo será atribuído a essa instância.
noProxyAccess

boolean

Se for "true", a instância do notebook não será registrada no proxy.
network

string

O nome da VPC em que a instância está. Formato: projects/{projectId}/global/networks/{network_id}
subnet

string

O nome da sub-rede em que a instância está. Formato: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
labels

map (key: string, value: string)

Rótulos a serem aplicados a esta instância. Elas podem ser modificadas mais tarde pelo método "setLabels".

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
metadata

map (key: string, value: string)

Metadados personalizados para aplicar a esta instância. Por exemplo, para especificar um bucket do Cloud Storage para backup automático, use a tag de metadados gcs-data-bucket. Formato: "--metadata=gcs-data-bucket=BUCKET".

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
tags[]

string

Opcional. As tags de rede do Compute Engine a serem adicionadas ao tempo de execução. Consulte Adicionar tags de rede.
upgradeHistory[]

object (UpgradeHistoryEntry)

O histórico de upgrades desta instância.
nicType

enum (NicType)

Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet.
reservationAffinity

object (ReservationAffinity)

Opcional. A afinidade de reserva opcional. Definir esse campo vai aplicar a reserva de computação zonal especificada a esta instância de notebook.
creator

string

Apenas saída. Endereço de e-mail da entidade que enviou a solicitação original "instances.create".
canIpForward

boolean

Opcional. Flag para ativar ou não o encaminhamento de IP. O padrão é "false"/desativado. https://cloud.google.com/vpc/docs/using-routes#canipforward
createTime

string (Timestamp format)

Apenas saída. Hora de criação da instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Horário de atualização da instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
instanceMigrationEligibility

object (InstanceMigrationEligibility)

Apenas saída. Verifica a viabilidade de uma migração do UmN para o WbI.
Tipo do ambiente. Pode ser uma imagem de VM ou imagem do contêiner. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
vmImage

object (VmImage)

Use uma imagem de VM do Compute Engine para iniciar a instância do notebook.
containerImage

object (ContainerImage)

Use uma imagem de contêiner para iniciar a instância de notebook.
Fim dos campos mutuamente exclusivos.
migrated

boolean

Apenas saída. Booleano que indica se este notebook foi migrado para uma instância do Workbench

AcceleratorConfig

Definição de um acelerador de hardware. Nem todas as combinações de type e coreCount são válidas. Consulte GPUs no Compute Engine para encontrar uma combinação válida. TPUs não são compatíveis.

Representação JSON 
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
Campos
type

enum (AcceleratorType)

Tipo do acelerador.
coreCount

string (int64 format)

Contagem de núcleos deste acelerador.

AcceleratorType

Definição dos tipos de aceleradores de hardware que podem ser usados nessa instância.

Tipos enumerados
ACCELERATOR_TYPE_UNSPECIFIED O tipo de acelerador não foi especificado.
NVIDIA_TESLA_K80 O tipo de acelerador é Nvidia Tesla K80.
NVIDIA_TESLA_P100 O tipo de acelerador é Nvidia Tesla P100.
NVIDIA_TESLA_V100 O tipo de acelerador é Nvidia Tesla V100.
NVIDIA_TESLA_P4 O tipo de acelerador é Nvidia Tesla P4.
NVIDIA_TESLA_T4 O tipo de acelerador é Nvidia Tesla T4.
NVIDIA_TESLA_A100 O tipo de acelerador é Nvidia Tesla A100.
NVIDIA_L4 O tipo de acelerador é Nvidia Tesla L4.
NVIDIA_A100_80GB O tipo de acelerador é Nvidia Tesla A100 de 80 GB.
NVIDIA_TESLA_T4_VWS O tipo de acelerador é NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS O tipo de acelerador é NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS O tipo de acelerador é NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_H100_80GB O tipo de acelerador é NVIDIA H100 de 80 GB.
NVIDIA_H100_MEGA_80GB O tipo de acelerador é NVIDIA H100 Mega de 80 GB.
TPU_V2 (Em breve) O tipo de acelerador é TPU V2.
TPU_V3 (Em breve) O tipo de acelerador é TPU V3.

Estado

A definição dos estados dessa instância.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
STARTING A lógica de controle está iniciando a instância.
PROVISIONING A lógica de controle está instalando os frameworks necessários e registrando a instância com o proxy do notebook.
ACTIVE A instância está em execução.
STOPPING A lógica de controle está interrompendo a instância.
STOPPED A instância está parada.
DELETED A instância é excluída.
UPGRADING A instância está sendo atualizada.
INITIALIZING A instância está sendo criada.
REGISTERING A instância está sendo registrada.
SUSPENDING A instância está sendo suspensa.
SUSPENDED A instância está suspensa.

DiskType

Tipos de disco possíveis para instâncias de notebook.

Tipos enumerados
DISK_TYPE_UNSPECIFIED Tipo de disco não definido.
PD_STANDARD Tipo de disco permanente padrão.
PD_SSD Tipo de disco permanente SSD.
PD_BALANCED Tipo de disco permanente equilibrado.
PD_EXTREME Tipo de disco permanente extremo.

DiskEncryption

Definição das opções de criptografia de disco.

Tipos enumerados
DISK_ENCRYPTION_UNSPECIFIED A criptografia de disco não foi especificada.
GMEK Use chaves de criptografia gerenciadas pelo Google para criptografar o disco de inicialização.
CMEK Use chaves de criptografia gerenciadas pelo cliente para criptografar o disco de inicialização.

Disco

Um recurso de disco anexado à instância.

Representação JSON 
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "diskSizeGb": string,
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "index": string,
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
Campos
autoDelete

boolean

Indica se o disco será excluído automaticamente quando a instância for excluída (mas não quando o disco for desconectado da instância).
boot

boolean

Indica que este é um disco de inicialização. A máquina virtual vai usar a primeira partição do disco para o sistema de arquivos raiz.
deviceName

string

Indica um nome de dispositivo exclusivo de sua escolha que é refletido na árvore /dev/disk/by-id/google-* de um sistema operacional Linux em execução na instância. Esse nome pode ser usado para fazer referência ao dispositivo durante a montagem, o redimensionamento e outras ações na instância.

Se não for especificado, o servidor vai escolher um nome de dispositivo padrão para aplicar a esse disco, no formato persistent-disk-x, em que x é um número atribuído pelo Google Compute Engine.Esse campo só é aplicável a discos permanentes.
diskSizeGb

string (int64 format)

Indica o tamanho do disco em GB de base 2.
guestOsFeatures[]

object (GuestOsFeature)

Indica uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis.
index

string (int64 format)

Um índice baseado em zero para este disco, em que 0 é reservado para o disco de inicialização. Se você tiver muitos discos anexados a uma instância, cada um terá um número de índice exclusivo.
interface

string

Indica a interface de disco a ser usada para anexar este disco, que é SCSI ou NVME. O padrão é SCSI. Os discos permanentes sempre precisam usar SCSI, e a solicitação vai falhar se você tentar anexar um disco permanente em qualquer outro formato. Os SSDs locais podem usar NVME ou SCSI. Para conhecer as características de desempenho do SCSI no NVMe, consulte "Desempenho do SSD local". Valores válidos:

  • NVME
  • SCSI
kind

string

Tipo do recurso. Sempre compute#attachedDisk para discos anexados.
licenses[]

string

Uma lista de licenças visíveis publicamente. Reservado para uso do Google. Uma licença representa dados de faturamento e uso agregado para imagens públicas e do marketplace.
mode

string

O modo em que este disco será anexado, READ_WRITE ou READ_ONLY. Se não for especificado, o padrão será anexar o disco no modo READ_WRITE. Valores válidos:

  • READ_ONLY
  • READ_WRITE
source

string

Indica um URL parcial ou completo válido para um recurso de Persistent Disk existente.
type

string

Indica o tipo de disco, SCRATCH ou PERSISTENT. Valores válidos:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

Recursos do SO convidado para o disco de inicialização.

Representação JSON 
{
  "type": string
}
Campos
type

string

O ID de um recurso compatível. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis. Valores válidos:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

ShieldedInstanceConfig

Um conjunto de opções de instância protegida. Consulte Imagens que usam recursos compatíveis de VM protegida. Nem todas as combinações são válidas.

Representação JSON 
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
Campos
enableSecureBoot

boolean

Define se a Inicialização segura está ativada na instância.

A Inicialização segura ajuda a garantir que o sistema execute apenas um software autêntico por meio da verificação da assinatura digital de todos os componentes de inicialização e da interrupção do processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão.
enableVtpm

boolean

Define se a instância tem o vTPM ativado. Ativado por padrão.
enableIntegrityMonitoring

boolean

Define se o monitoramento de integridade está ativado na instância.

Permite o monitoramento e o atestado da integridade da inicialização da instância. O atestado é realizado em relação ao valor de referência da política de integridade. Esse valor de referência é derivado inicialmente da imagem de inicialização implicitamente confiável quando a instância é criada. Ativado por padrão.

UpgradeHistoryEntry

A entrada do histórico de upgrade de imagem de VM.

Representação JSON 
{
  "snapshot": string,
  "vmImage": string,
  "containerImage": string,
  "framework": string,
  "version": string,
  "state": enum (State),
  "createTime": string,
  "targetImage": string,
  "action": enum (Action),
  "targetVersion": string
}
Campos
snapshot

string

O snapshot do disco de inicialização da instância de notebook antes do upgrade.
vmImage

string

A imagem da VM antes do upgrade da instância.
containerImage

string

A imagem do contêiner antes do upgrade da instância.
framework

string

O framework desta instância de notebook.
version

string

A versão da instância de notebook antes deste upgrade.
state

enum (State)

O estado desta entrada do histórico de upgrades da instância.
createTime

string (Timestamp format)

O horário em que esta entrada do histórico de upgrade da instância foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
targetImage
(deprecated)

string

Imagem da VM de destino. Formato: ainotebooks-vm/project/image-name/name.
action

enum (Action)

Ação. Reverter ou fazer upgrade.
targetVersion

string

Versão da VM de destino, como m63.

Estado

A definição dos estados desta entrada do histórico de upgrade.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
STARTED O upgrade da instância é iniciado.
SUCCEEDED O upgrade da instância foi concluído.
FAILED O upgrade da instância falhou.

Ação

A definição das operações desta entrada do histórico de upgrade.

Tipos enumerados
ACTION_UNSPECIFIED Nenhuma operação foi especificada.
UPGRADE Faça upgrade.
ROLLBACK Rollback.

NicType

O tipo de driver de vNIC. O padrão precisa ser UNSPECIFIED_NIC_TYPE.

Tipos enumerados
UNSPECIFIED_NIC_TYPE Nenhum tipo especificado.
VIRTIO_NET VIRTIO
GVNIC GVNIC

ReservationAffinity

Afinidade de reserva para consumir uma reserva zonal.

Representação JSON 
{
  "consumeReservationType": enum (Type),
  "key": string,
  "values": [
    string
  ]
}
Campos
consumeReservationType

enum (Type)

Opcional. Tipo de reserva a ser consumida
key

string

Opcional. Corresponde à chave do rótulo do recurso de reserva.
values[]

string

Opcional. Corresponde aos valores de rótulo do recurso de reserva.

Tipo

Indica se é necessário consumir capacidade de uma reserva ou não.

Tipos enumerados
TYPE_UNSPECIFIED Tipo padrão.
NO_RESERVATION Não consumir de nenhuma capacidade alocada.
ANY_RESERVATION Consumir qualquer reserva disponível.
SPECIFIC_RESERVATION Precisa consumir de uma reserva específica. É necessário especificar campos de valor-chave para especificar as reservas.

InstanceMigrationEligibility

"InstanceMigrationEligibility" representa as informações de viabilidade de uma migração do UmN para o WbI.

Representação JSON 
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
Campos
warnings[]

enum (Warning)

Apenas saída. Algumas configurações serão definidas como padrão durante a migração.
errors[]

enum (Error)

Apenas saída. Algumas configurações tornam o UmN inelegível para uma migração automática. É necessária uma migração manual.

Aviso

Uma mensagem de aviso de migração significa que algumas configurações serão definidas como padrão durante a migração.

Tipos enumerados
WARNING_UNSPECIFIED Tipo padrão.
UNSUPPORTED_MACHINE_TYPE O UmN usa um tipo de máquina que não tem suporte no WbI. Ele será migrado com o tipo de máquina padrão e2-standard-4. Os usuários podem mudar o tipo de máquina depois da migração.
UNSUPPORTED_ACCELERATOR_TYPE O UmN usa um tipo de acelerador que não é compatível com o WbI. Ele será migrado sem um acelerador. O usuário pode anexar um acelerador após a migração.
UNSUPPORTED_OS O UmN usa um sistema operacional que não é compatível com o WbI (por exemplo, Debian 10, Ubuntu). Ele será substituído pelo Debian 11 no WbI.
NO_REMOVE_DATA_DISK Este UmN está configurado com noRemoveDataDisk, que não está mais disponível no WbI.
GCS_BACKUP Este UmN é configurado com o recurso de backup do Cloud Storage, que não está mais disponível no WbI.
POST_STARTUP_SCRIPT Essa UmN está configurada com um script pós-inicialização. Se quiser, forneça o postStartupScriptOption para a migração.

Erro

Uma mensagem de erro de migração significa que determinadas configurações tornam o UmN inelegível para uma migração automática. É necessária uma migração manual.

Tipos enumerados
ERROR_UNSPECIFIED Tipo padrão.
DATAPROC_HUB O UmN usa o hub do Dataproc e não pode ser migrado.

Métodos

create

 Cria uma nova instância em um determinado projeto e local.

delete

 Exclui uma única instância.

diagnose

 Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico com base em uma instância.

get

 Recebe detalhes de uma única instância.

getIamPolicy

 Busca a política de controle de acesso de um recurso.

getInstanceHealth

 Verifica se uma instância de notebook está íntegra.

isUpgradeable

 Verifica se uma instância de notebook pode ser atualizada.

list

 Lista as instâncias em determinado projeto e local.

migrate

 Migra um notebook gerenciado pelo usuário para instâncias do Workbench.

register

 Registra uma instância de notebook legada no servidor da API Notebooks.

report

 Permite que as instâncias de notebook informem as informações mais recentes da instância ao servidor da API Notebooks.

reset

 Redefine uma instância de notebook.

rollback

 Reverte uma instância de notebook para a versão anterior.

setAccelerator

 Atualiza os aceleradores convidados de uma única instância.

setIamPolicy

 Define a política de controle de acesso no recurso especificado.

setLabels

 Substitui todos os rótulos de uma instância.

setMachineType

 Atualiza o tipo de máquina de uma única instância.

start

 Inicia uma instância de notebook.

stop

 Interrompe uma instância de notebook.

testIamPermissions

 Retorna permissões do autor da chamada no recurso especificado.

updateConfig

 Atualize as configurações da instância de notebook.

updateMetadataItems

 Adiciona/atualiza itens de metadados para uma instância.

updateShieldedInstanceConfig

 Atualiza a configuração de instância protegida de uma única instância.

upgrade

 Faz upgrade de uma instância de notebook para a versão mais recente.