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 ( |
| Campos | |
|---|---|
name |
Apenas saída. Identificador. O nome desta instância de notebook. Formato: |
proxyUri |
Apenas saída. O endpoint de proxy usado para acessar o notebook Jupyter. |
instanceOwners[] |
Opcional. O proprietário dessa instância após a criação. Formato: 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 |
Apenas saída. Endereço de e-mail da entidade que enviou a solicitação original "instances.create". |
state |
Apenas saída. O estado desta instância. |
upgradeHistory[] |
Apenas saída. O histórico de upgrades desta instância. |
id |
Apenas saída. ID exclusivo do recurso. |
healthState |
Apenas saída. healthState da instância. |
healthInfo |
Apenas saída. Informações adicionais sobre a integridade da instância. Exemplo: Um objeto com uma lista de pares |
createTime |
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: |
updateTime |
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: |
disableProxyAccess |
Opcional. Se for "true", a instância do notebook não será registrada no proxy. |
labels |
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 |
thirdPartyProxyUrl |
Apenas saída. O endpoint de proxy dos pools de colaboradores usado para acessar o notebook Jupyter. |
satisfiesPzs |
Apenas saída. Reservado para uso futuro na separação de zonas. |
satisfiesPzi |
Apenas saída. Reservado para uso futuro no isolamento de zona. |
enableThirdPartyIdentity |
Opcional. Flag que especifica que um notebook pode ser acessado com um provedor de identidade de terceiros. |
enableManagedEuc |
Opcional. Flag para ativar as credenciais gerenciadas de usuário final para a instância. |
enableDeletionProtection |
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. |
| Configuração da instância de notebook. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
gceSetup |
Opcional. Configuração do Compute Engine para o notebook. Usa campos definidos no notebook. |
| Fim dos campos mutuamente exclusivos. | |
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 ( |
| Campos | |
|---|---|
machineType |
Opcional. O tipo de máquina da instância de VM. https://cloud.google.com/compute/docs/machine-resource |
minCpuPlatform |
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[] |
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 |
serviceAccounts[] |
Opcional. A conta de serviço que serve como identidade para a instância de VM. No momento, só é possível usar uma conta de serviço. |
bootDisk |
Opcional. O disco de inicialização da VM. |
dataDisks[] |
Opcional. Discos de dados anexados à instância de VM. No momento, só há suporte para um disco de dados. |
shieldedInstanceConfig |
Opcional. Configuração de VM protegida. Imagens que usam recursos compatíveis de VM protegida. |
networkInterfaces[] |
Opcional. As interfaces de rede da VM. Aceita apenas uma interface. |
disablePublicIp |
Opcional. Se for "true", nenhum IP externo será atribuído a esta instância de VM. |
tags[] |
Opcional. As tags de rede do Compute Engine a serem adicionadas ao tempo de execução. Consulte Adicionar tags de rede. |
metadata |
Opcional. Metadados personalizados para aplicar a esta instância. Um objeto com uma lista de pares |
systemMetadata |
Apenas saída. Representa metadados gerenciados pelo sistema para esta instância: o subconjunto de Um objeto com uma lista de pares |
enableIpForwarding |
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 |
Opcional. Configuração para drivers de GPU. |
confidentialInstanceConfig |
Opcional. Configuração de instância confidencial. |
instanceId |
Apenas saída. O ID exclusivo do recurso de instância do Compute Engine. |
| Tipo da imagem. 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 |
Opcional. Use uma imagem de VM do Compute Engine para iniciar a instância do notebook. |
containerImage |
Opcional. Use uma imagem de contêiner para iniciar a instância de notebook. |
| Fim dos campos mutuamente exclusivos. | |
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 ( |
| Campos | |
|---|---|
type |
Opcional. Tipo do acelerador. |
coreCount |
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 |
Descontinuado: use |
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 de 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 80GB. |
NVIDIA_H200_141GB |
O tipo de acelerador é Nvidia Tesla H200 de 141 GB. |
NVIDIA_TESLA_T4_VWS |
O tipo de acelerador é NVIDIA Tesla T4 Virtual Workstations. |
NVIDIA_TESLA_P100_VWS |
Descontinuado: use |
NVIDIA_TESLA_P4_VWS |
O tipo de acelerador é NVIDIA Tesla P4 Virtual Workstations. |
NVIDIA_B200 |
O tipo de acelerador é NVIDIA B200. |
NVIDIA_RTX6000 |
NVIDIA RTX 6000. |
ServiceAccount
Uma conta de serviço que atua como uma identidade.
| Representação JSON |
|---|
{ "email": string, "scopes": [ string ] } |
| Campos | |
|---|---|
email |
Opcional. Endereço de e-mail da conta de serviço. |
scopes[] |
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 de máquina virtual personalizada do Compute Engine para iniciar uma instância de notebook com o ambiente instalado diretamente na VM.
| Representação JSON |
|---|
{ "project": string, "imageDescription": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "name": string, "family": string // End of mutually exclusive fields. } |
| Campos | |
|---|---|
project |
Obrigatório. O nome do projeto na nuvem do Google Cloud a que esta imagem de VM pertence. Formato: |
imageDescription |
Apenas saída. Uma descrição legível por humanos da imagem em execução na instância (por exemplo, "Debian 11, Python 3.10"), derivada no momento da leitura da configuração de lançamento da imagem (a fonte da verdade). Defina como "Personalizado" para imagens de disco de inicialização não reconhecidas. |
| A referência a uma imagem de VM externa do Compute Engine. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
name |
Opcional. Use o nome da imagem da VM para encontrar a imagem. |
family |
Opcional. Use essa família de imagens de VM para encontrar a imagem. A imagem mais recente dessa família será usada. |
| Fim dos campos mutuamente exclusivos. | |
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 |
Obrigatório. O caminho para o repositório de imagens do contêiner. Por exemplo: |
tag |
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 ( |
| Campos | |
|---|---|
diskSizeGb |
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 |
Opcional. Indica o tipo de disco. |
diskEncryption |
Opcional. Método de criptografia de disco usado nos discos de inicialização e de dados. O padrão é GMEK. |
kmsKey |
Opcional. A chave do KMS usada para criptografar os discos. Só é aplicável se diskEncryption for CMEK. Formato: 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 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 ( |
| Campos | |
|---|---|
diskSizeGb |
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 |
Opcional. Indica o tipo de disco. |
diskEncryption |
Opcional. Método de criptografia de disco usado nos discos de inicialização e de dados. O padrão é GMEK. |
kmsKey |
Opcional. A chave do KMS usada para criptografar os discos. Só é aplicável se diskEncryption for CMEK. Formato: Saiba mais sobre como usar suas próprias chaves de criptografia. |
resourcePolicies[] |
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 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 |
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 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 |
Opcional. Define se a instância de VM tem o vTPM ativado. |
enableIntegrityMonitoring |
Opcional. Define se o monitoramento de integridade está ativado na instância de VM. Permite o monitoramento e a atestação 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 ( |
| Campos | |
|---|---|
network |
Opcional. O nome da VPC em que essa instância de VM está. Formato: |
subnet |
Opcional. O nome da sub-rede em que a instância de VM está. Formato: |
nicType |
Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet. |
accessConfigs[] |
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. |
internalIp |
Opcional. Um endereço IP interno associado a esta instância. Especifique um endereço IP interno estático não utilizado disponível para a sub-rede em que a instância está ou deixe esse campo indefinido para usar um IP do intervalo temporário da sub-rede. |
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 |
Opcional. 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 da zona da instância. |
GPUDriverConfig
Uma configuração de driver de GPU
| Representação JSON |
|---|
{ "enableGpuDriver": boolean, "customGpuDriverPath": string } |
| Campos | |
|---|---|
enableGpuDriver |
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 de GPU não será instalado. Aplicável apenas a instâncias com GPUs. |
customGpuDriverPath |
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 ( |
| Campos | |
|---|---|
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. |
ORPHANED |
A instância não tem VM. Um upgrade removeu o original e não conseguiu criar a substituição. O disco de dados e todos os snapshots estão intactos. Tente fazer o upgrade de novo para concluir ou reverta a instância para o snapshot feito antes do início. |
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 ( |
| Campos | |
|---|---|
snapshot |
Opcional. O snapshot do disco de inicialização da instância de notebook antes do upgrade. |
vmImage |
Opcional. A imagem da VM antes do upgrade da instância. |
containerImage |
Opcional. A imagem do contêiner antes do upgrade da instância. |
framework |
Opcional. O framework desta instância de notebook. |
version |
Opcional. A versão da instância de notebook antes deste upgrade. |
state |
Apenas saída. O estado desta entrada do histórico de upgrades da instância. |
createTime |
Imutável. 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: |
action |
Opcional. Ação. Reverter ou fazer upgrade. |
targetVersion |
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 |
Nenhuma operaçã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 ATIVO. |
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 |
|
|---|---|
|
Verifica se uma instância de notebook pode ser atualizada. |
|
Cria uma nova instância em um determinado projeto e local. |
|
Exclui uma única instância. |
|
Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico com base em uma instância. |
|
Recebe detalhes de uma única instância. |
|
Retorna vários parâmetros de configuração. |
|
Busca a política de controle de acesso de um recurso. |
|
Lista as instâncias em determinado projeto e local. |
|
O UpdateInstance atualiza uma instância. |
|
Redefine uma instância de notebook. |
|
Redimensione o disco de uma instância de notebook para uma capacidade maior. |
|
"RestoreInstance" restaura uma instância de um "BackupSource". |
|
Reverte uma instância de notebook para a versão anterior. |
|
Define a política de controle de acesso no recurso especificado. |
|
Inicia uma instância de notebook. |
|
Interrompe uma instância de notebook. |
|
Retorna permissões do autor da chamada no recurso especificado. |
|
Faz upgrade de uma instância de notebook para a versão mais recente. |