REST Resource: projects.locations.instances

Recurso: instância

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

Representação JSON 
{
  "name": string,
  "proxyUri": string,
  "instanceOwners": [
    string
  ],
  "creator": string,
  "state": enum (State),
  "upgradeHistory": [
    {
      object (UpgradeHistoryEntry)
    }
  ],
  "id": string,
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "disableProxyAccess": boolean,
  "labels": {
    string: string,
    ...
  },
  "thirdPartyProxyUrl": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "enableThirdPartyIdentity": boolean,
  "enableManagedEuc": boolean,
  "enableDeletionProtection": boolean,

  // Union field infrastructure can be only one of the following:
  "gceSetup": {
    object (GceSetup)
  }
  // End of list of possible types for union field infrastructure.
}
Campos
name

string

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

string

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

string

Opcional. 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.
creator

string

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

enum (State)

Apenas saída. O estado desta instância.
upgradeHistory[]

object (UpgradeHistoryEntry)

Apenas saída. O histórico de upgrades desta instância.
id

string

Apenas saída. ID exclusivo do recurso.
healthState

enum (HealthState)

Apenas saída. healthState da instância.
healthInfo

map (key: string, value: string)

Apenas saída. Informações adicionais sobre a integridade da instância. Exemplo:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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".
disableProxyAccess

boolean

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

map (key: string, value: string)

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

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

string

Apenas saída. O endpoint de proxy dos pools de colaboradores usado para acessar o notebook Jupyter.
satisfiesPzs

boolean

Apenas saída. Reservado para uso futuro na separação de zonas.
satisfiesPzi

boolean

Apenas saída. Reservado para uso futuro no isolamento de zona.
enableThirdPartyIdentity

boolean

Opcional. Flag que especifica que um notebook pode ser acessado com um provedor de identidade de terceiros.
enableManagedEuc

boolean

Opcional. Flag para ativar as credenciais gerenciadas de usuário final para a instância.
enableDeletionProtection

boolean

Opcional. Se for "true", a proteção contra exclusão será ativada para esta instância do Workbench. Se for "false", a proteção contra exclusão será desativada para esta instância do Workbench.
Campo de união infrastructure. Configuração da instância de notebook. infrastructure pode ser apenas de um dos tipos a seguir:
gceSetup

object (GceSetup)

Opcional. Configuração do Compute Engine para o notebook. Usa campos definidos no notebook.

GceSetup

A definição de como configurar uma instância de VM fora de "Recursos e identidade".

Representação JSON 
{
  "machineType": string,
  "minCpuPlatform": string,
  "acceleratorConfigs": [
    {
      object (AcceleratorConfig)
    }
  ],
  "serviceAccounts": [
    {
      object (ServiceAccount)
    }
  ],
  "bootDisk": {
    object (BootDisk)
  },
  "dataDisks": [
    {
      object (DataDisk)
    }
  ],
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "networkInterfaces": [
    {
      object (NetworkInterface)
    }
  ],
  "disablePublicIp": boolean,
  "tags": [
    string
  ],
  "metadata": {
    string: string,
    ...
  },
  "enableIpForwarding": boolean,
  "gpuDriverConfig": {
    object (GPUDriverConfig)
  },
  "confidentialInstanceConfig": {
    object (ConfidentialInstanceConfig)
  },
  "instanceId": string,

  // Union field image can be only one of the following:
  "vmImage": {
    object (VmImage)
  },
  "containerImage": {
    object (ContainerImage)
  }
  // End of list of possible types for union field image.
}
Campos
machineType

string

Opcional. O tipo de máquina da instância de VM. https://cloud.google.com/compute/docs/machine-resource
minCpuPlatform

string

Opcional. A plataforma de CPU mínima a ser usada para esta instância. A lista de valores válidos pode ser encontrada em https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
acceleratorConfigs[]

object (AcceleratorConfig)

Opcional. Os aceleradores de hardware usados nesta instância. Se você usar aceleradores, verifique se a configuração tem vCPUs e memória suficientes para oferecer suporte ao machineType selecionado. No momento, só há suporte para uma configuração de acelerador.
serviceAccounts[]

object (ServiceAccount)

Opcional. A conta de serviço que serve como uma identidade para a instância de VM. No momento, só é possível usar uma conta de serviço.
bootDisk

object (BootDisk)

Opcional. O disco de inicialização da VM.
dataDisks[]

object (DataDisk)

Opcional. Discos de dados anexados à instância de VM. No momento, só há suporte para um disco de dados.
shieldedInstanceConfig

object (ShieldedInstanceConfig)

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

object (NetworkInterface)

Opcional. As interfaces de rede da VM. Aceita apenas uma interface.
disablePublicIp

boolean

Opcional. Se for "true", nenhum IP externo será atribuído a esta instância de VM.
tags[]

string

Opcional. As tags de rede do Compute Engine a serem adicionadas ao ambiente de execução. Consulte Adicionar tags de rede.
metadata

map (key: string, value: string)

Opcional. Metadados personalizados a serem aplicados a esta instância.

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

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
gpuDriverConfig

object (GPUDriverConfig)

Opcional. Configuração para drivers de GPU.
confidentialInstanceConfig

object (ConfidentialInstanceConfig)

Opcional. Configuração de instância confidencial.
instanceId

string

Apenas saída. O ID exclusivo do recurso de instância do Compute Engine.
Campo de união image. Tipo da imagem. Pode ser uma imagem de VM ou imagem do contêiner. image pode ser apenas de um dos tipos a seguir:
vmImage

object (VmImage)

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

object (ContainerImage)

Opcional. Use uma imagem de contêiner para iniciar a instância do notebook.

AcceleratorConfig

Uma configuração de acelerador para uma definição de instância de VM de um acelerador de hardware. Observação: não há verificação nas combinações de type e coreCount. TPUs não são compatíveis. Consulte GPUs no Compute Engine para encontrar uma combinação válida.

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

enum (AcceleratorType)

Opcional. Tipo deste acelerador.
coreCount

string (int64 format)

Opcional. 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_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 - 40 GB.
NVIDIA_A100_80GB O tipo de acelerador é Nvidia Tesla A100 - 80 GB.
NVIDIA_L4 O tipo de acelerador é Nvidia Tesla L4.
NVIDIA_H100_80GB O tipo de acelerador é Nvidia Tesla H100 - 80 GB.
NVIDIA_H100_MEGA_80GB O tipo de acelerador é Nvidia Tesla H100 - MEGA 80 GB.
NVIDIA_H200_141GB O tipo de acelerador é Nvidia Tesla H200 - 141 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_B200 O tipo de acelerador é NVIDIA B200.

ServiceAccount

Uma conta de serviço que atua como uma identidade.

Representação JSON 
{
  "email": string,
  "scopes": [
    string
  ]
}
Campos
email

string

Opcional. Endereço de e-mail da conta de serviço.
scopes[]

string

Apenas saída. A lista de escopos a serem disponibilizados para essa conta de serviço. Definido pelo CLH como https://www.googleapis.com/auth/cloud-platform

VmImage

Definição de uma imagem personalizada de máquina virtual do Compute Engine para iniciar uma instância de notebook com o ambiente instalado diretamente na VM.

Representação JSON 
{
  "project": string,

  // Union field image can be only one of the following:
  "name": string,
  "family": string
  // End of list of possible types for union field image.
}
Campos
project

string

Obrigatório. O nome do projeto na nuvem do Google Cloud a que esta imagem de VM pertence. Formato: {projectId}
Campo de união image. A referência a uma imagem de VM externa do Compute Engine. image pode ser apenas de um dos tipos a seguir:
name

string

Opcional. Use o nome da imagem da VM para encontrar a imagem.
family

string

Opcional. Use essa família de imagens de VM para encontrar a imagem. A imagem mais recente dessa família será usada.

ContainerImage

Definição de uma imagem de contêiner para iniciar uma instância de notebook com o ambiente instalado em um contêiner.

Representação JSON 
{
  "repository": string,
  "tag": string
}
Campos
repository

string

Obrigatório. O caminho para o repositório de imagens do contêiner. Por exemplo: gcr.io/{projectId}/{imageName}
tag

string

Opcional. A tag da imagem do contêiner. Se não for especificado, o padrão será a tag mais recente.

BootDisk

A definição de um disco de inicialização.

Representação JSON 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string
}
Campos
diskSizeGb

string (int64 format)

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

enum (DiskType)

Opcional. Indica o tipo do disco.
diskEncryption

enum (DiskEncryption)

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

string

Opcional. 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.

DiskType

Tipos de disco possíveis.

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.
HYPERDISK_BALANCED Representa o tipo de disco permanente Hyperdisk Balanced. Pode ser usado como disco de inicialização ou de dados.
HYPERDISK_EXTREME Representa o tipo de disco permanente Hyperdisk Extreme. Só pode ser usado como um disco de dados.
HYPERDISK_THROUGHPUT Representa o tipo de disco permanente Hyperdisk Throughput. Só pode ser usado como um disco de dados.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Representa o tipo de disco permanente do Hyperdisk Balanced High Availability. Pode ser usado como disco de inicialização ou de dados.
HYPERDISK_ML Representa o tipo de disco permanente do Hyperdisk ML. Pode ser usado como disco de inicialização ou de dados.

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.

DataDisk

Um recurso de disco anexado à instância.

Representação JSON 
{
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "diskEncryption": enum (DiskEncryption),
  "kmsKey": string,
  "resourcePolicies": [
    string
  ]
}
Campos
diskSizeGb

string (int64 format)

Opcional. O tamanho do disco em GB anexado a esta instância de VM, até um máximo de 64.000 GB (64 TB). Se não for especificado, o padrão será 100.
diskType

enum (DiskType)

Opcional. Somente entrada. Indica o tipo do disco.
diskEncryption

enum (DiskEncryption)

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

string

Opcional. 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.
resourcePolicies[]

string

Opcional. As políticas de recursos a serem aplicadas ao disco de dados.

ShieldedInstanceConfig

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

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

boolean

Opcional. Define se a instância de VM tem a Inicialização segura ativada.

A Inicialização segura ajuda a garantir que o sistema execute apenas softwares autênticos. Para isso, ela verifica a assinatura digital de todos os componentes de inicialização e interrompe o processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão.
enableVtpm

boolean

Opcional. Define se a instância de VM tem o vTPM ativado.
enableIntegrityMonitoring

boolean

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

Ativa o monitoramento e o atestado da integridade da inicialização da instância de VM. 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 de VM é criada.

NetworkInterface

A definição de um recurso de interface de rede anexado a uma VM.

Representação JSON 
{
  "network": string,
  "subnet": string,
  "nicType": enum (NicType),
  "accessConfigs": [
    {
      object (AccessConfig)
    }
  ]
}
Campos
network

string

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

string

Opcional. O nome da sub-rede em que esta instância de VM está. Formato: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
nicType

enum (NicType)

Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet.
accessConfigs[]

object (AccessConfig)

Opcional. Uma matriz de configurações para essa interface. No momento, apenas uma configuração de acesso, ONE_TO_ONE_NAT, é aceita. Se nenhum accessConfigs for especificado, a instância terá um acesso externo à Internet por um endereço IP externo temporário.

NicType

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

Tipos enumerados
NIC_TYPE_UNSPECIFIED Nenhum tipo especificado.
VIRTIO_NET VIRTIO
GVNIC GVNIC

AccessConfig

Uma configuração de acesso anexada à interface de rede de uma instância.

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

string

Um endereço IP externo associado a esta instância. Especifique um endereço IP externo estático não utilizado disponível para o projeto ou deixe esse campo indefinido para usar um IP de um pool compartilhado de endereços IP temporários. Se você especificar um endereço IP externo estático, ele precisará estar na mesma região que a zona da instância.

GPUDriverConfig

Uma configuração de driver de GPU

Representação JSON 
{
  "enableGpuDriver": boolean,
  "customGpuDriverPath": string
}
Campos
enableGpuDriver

boolean

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

string

Opcional. 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.

ConfidentialInstanceConfig

Um conjunto de opções de instância confidencial.

Representação JSON 
{
  "confidentialInstanceType": enum (ConfidentialInstanceType)
}
Campos
confidentialInstanceType

enum (ConfidentialInstanceType)

Opcional. Define o tipo de tecnologia usada pela instância confidencial.

ConfidentialInstanceType

O tipo de instância confidencial.

Tipos enumerados
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Nenhum tipo especificado. Não use esse valor.
SEV AMD Secure Encrypted Virtualization.

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.
SUSPENDING A instância está sendo suspensa.
SUSPENDED A instância está suspensa.

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,
  "action": enum (Action),
  "targetVersion": string
}
Campos
snapshot

string

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

string

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

string

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

string

Opcional. A estrutura da instância do notebook.
version

string

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

enum (State)

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

string (Timestamp format)

Imutável. O horário em que esta entrada do histórico de upgrades 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".
action

enum (Action)

Opcional. Ação. Reverter ou fazer upgrade.
targetVersion

string

Opcional. 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 A operação não foi especificada.
UPGRADE Faça upgrade.
ROLLBACK Rollback.

HealthState

O estado de integridade da instância.

Tipos enumerados
HEALTH_STATE_UNSPECIFIED O subestado da instância é desconhecido.
HEALTHY A instância está em um estado íntegro (por exemplo, daemons críticos estão em execução). Aplica-se ao estado "ACTIVE".
UNHEALTHY A instância está em um estado não íntegro (por exemplo, daemons críticos não estão em execução). Aplica-se ao estado ACTIVE.
AGENT_NOT_INSTALLED A instância não tem o agente de monitoramento de integridade instalado. Aplicável ao estado ATIVO.
AGENT_NOT_RUNNING O agente de monitoramento de integridade da instância não está em execução. Aplicável ao estado ATIVO.

Métodos

checkUpgradability

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

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 em uma instância.

get

 Recebe detalhes de uma única instância.

getConfig

 Retorna vários parâmetros de configuração.

getIamPolicy

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

list

 Lista instâncias em um determinado projeto e local.

patch

 O UpdateInstance atualiza uma instância.

reset

 Redefine uma instância de notebook.

resizeDisk

 Redimensione o disco de uma instância de notebook para uma capacidade maior.

restore

 "RestoreInstance" restaura uma instância de um "BackupSource".

rollback

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

setIamPolicy

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

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.

upgrade

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