Recurso: Instancia
Es la definición de una instancia de notebook.
| Representación JSON |
|---|
{ "name": string, "proxyUri": string, "instanceOwners": [ string ], "creator": string, "state": enum ( |
| Campos | |
|---|---|
name |
Solo salida. Es el identificador. Es el nombre de esta instancia de notebook. Formato: |
proxyUri |
Solo salida. Es el extremo del proxy que se usa para acceder al notebook de Jupyter. |
instanceOwners[] |
Es opcional. Es el propietario de esta instancia después de la creación. Formato: Actualmente, solo admite un propietario. Si no se especifica, todos los usuarios de la cuenta de servicio de la instancia de VM pueden usar la instancia. |
creator |
Solo salida. Dirección de correo electrónico de la entidad que envió la solicitud original de instances.create. |
state |
Solo salida. Es el estado de esta instancia. |
upgradeHistory[] |
Solo salida. Es el historial de actualizaciones de esta instancia. |
id |
Solo salida. Es el ID único del recurso. |
healthState |
Solo salida. Es el estado de la instancia. |
healthInfo |
Solo salida. Es información adicional sobre el estado de la instancia. Ejemplo: Un objeto que contiene una lista de pares |
createTime |
Solo salida. Es la fecha y hora de creación de la instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
updateTime |
Solo salida. Es la fecha y hora de actualización de la instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
disableProxyAccess |
Es opcional. Si es verdadero, la instancia del notebook no se registrará en el proxy. |
labels |
Es opcional. Son las etiquetas que se aplicarán a esta instancia. Las instancias pueden modificarlos más adelante con el método instances.patch. Un objeto que contiene una lista de pares |
thirdPartyProxyUrl |
Solo salida. Es el extremo del proxy de grupos de personal que se usa para acceder al notebook de Jupyter. |
satisfiesPzs |
Solo salida. Se reserva para usarlo más adelante en la separación de zonas. |
satisfiesPzi |
Solo salida. Se reserva para uso futuro en el aislamiento de zonas. |
enableThirdPartyIdentity |
Es opcional. Es una marca que especifica que se puede acceder a un notebook con un proveedor de identidad externo. |
enableManagedEuc |
Es opcional. Es una marca para habilitar las credenciales de usuario final administradas para la instancia. |
enableDeletionProtection |
Es opcional. Si es verdadero, se habilitará la protección contra eliminaciones para esta instancia de Workbench. Si es falso, se inhabilitará la protección contra eliminaciones para esta instancia de Workbench. |
Campo de unión infrastructure. Es la configuración de la instancia de Notebook. infrastructure puede ser solo uno de los parámetros siguientes: |
|
gceSetup |
Es opcional. Es la configuración de Compute Engine para el notebook. Usa campos definidos en el notebook. |
GceSetup
Es la definición de cómo configurar una instancia de VM fuera de Resources and Identity.
| Representación JSON |
|---|
{ "machineType": string, "minCpuPlatform": string, "acceleratorConfigs": [ { object ( |
| Campos | |
|---|---|
machineType |
Es opcional. Es el tipo de máquina de la instancia de VM. https://cloud.google.com/compute/docs/machine-resource |
minCpuPlatform |
Es opcional. Es la plataforma de CPU mínima que se usará para esta instancia. Puedes encontrar la lista de valores válidos en https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones |
acceleratorConfigs[] |
Es opcional. Son los aceleradores de hardware que se usan en esta instancia. Si usas aceleradores, asegúrate de que tu configuración tenga suficientes CPU virtuales y memoria para admitir la |
serviceAccounts[] |
Es opcional. Es la cuenta de servicio que funciona como identidad para la instancia de VM. Actualmente, solo se admite una cuenta de servicio. |
bootDisk |
Es opcional. Es el disco de arranque de la VM. |
dataDisks[] |
Es opcional. Son los discos de datos conectados a la instancia de VM. Actualmente, solo admite un disco de datos. |
shieldedInstanceConfig |
Es opcional. Configuración de VM protegida. Imágenes que usan funciones compatibles de la VM protegida |
networkInterfaces[] |
Es opcional. Son las interfaces de red de la VM. Solo admite una interfaz. |
disablePublicIp |
Es opcional. Si es verdadero, no se asignará ninguna IP externa a esta instancia de VM. |
tags[] |
Es opcional. Son las etiquetas de red de Compute Engine que se agregarán al tiempo de ejecución (consulta Agrega etiquetas de red). |
metadata |
Es opcional. Son los metadatos personalizados que se aplicarán a esta instancia. Un objeto que contiene una lista de pares |
enableIpForwarding |
Es opcional. Es una marca para habilitar o no el reenvío de IP. El valor predeterminado es falso o desactivado. https://cloud.google.com/vpc/docs/using-routes#canipforward |
gpuDriverConfig |
Es opcional. Es la configuración de los controladores de GPU. |
confidentialInstanceConfig |
Es opcional. Es la configuración de la instancia confidencial. |
instanceId |
Solo salida. Es el ID único del recurso de instancia de Compute Engine. |
Campo de unión image. Es el tipo de imagen, que puede ser imagen de VM o imagen de contenedor. image puede ser solo uno de los parámetros siguientes: |
|
vmImage |
Es opcional. Usa una imagen de VM de Compute Engine para iniciar la instancia de notebook. |
containerImage |
Es opcional. Usa una imagen de contenedor para iniciar la instancia del notebook. |
AcceleratorConfig
Es la configuración de un acelerador para una instancia de VM. Es la definición de un acelerador de hardware. Ten en cuenta que no se realiza ninguna verificación en las combinaciones de type y coreCount. Las TPU no son compatibles. Consulta GPU en Compute Engine para encontrar una combinación válida.
| Representación JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Es opcional. Es el tipo de este acelerador. |
coreCount |
Es opcional. Es la cantidad de núcleos de este acelerador. |
AcceleratorType
Es la definición de los tipos de aceleradores de hardware que se pueden usar en esta instancia.
| Enums | |
|---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
No se especificó el tipo de acelerador. |
NVIDIA_TESLA_P100 |
El tipo de acelerador es Nvidia Tesla P100. |
NVIDIA_TESLA_V100 |
El tipo de acelerador es Nvidia Tesla V100. |
NVIDIA_TESLA_P4 |
El tipo de acelerador es Nvidia Tesla P4. |
NVIDIA_TESLA_T4 |
El tipo de acelerador es Nvidia Tesla T4. |
NVIDIA_TESLA_A100 |
El tipo de acelerador es Nvidia Tesla A100 de 40 GB. |
NVIDIA_A100_80GB |
El tipo de acelerador es Nvidia Tesla A100, 80 GB. |
NVIDIA_L4 |
El tipo de acelerador es Nvidia Tesla L4. |
NVIDIA_H100_80GB |
El tipo de acelerador es Nvidia Tesla H100 - 80 GB. |
NVIDIA_H100_MEGA_80GB |
El tipo de acelerador es Nvidia Tesla H100 - MEGA 80 GB. |
NVIDIA_H200_141GB |
El tipo de acelerador es Nvidia Tesla H200, con 141 GB. |
NVIDIA_TESLA_T4_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla T4. |
NVIDIA_TESLA_P100_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P100. |
NVIDIA_TESLA_P4_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P4. |
NVIDIA_B200 |
El tipo de acelerador es NVIDIA B200. |
ServiceAccount
Una cuenta de servicio que actúa como identidad.
| Representación JSON |
|---|
{ "email": string, "scopes": [ string ] } |
| Campos | |
|---|---|
email |
Es opcional. Es la dirección de correo electrónico de la cuenta de servicio. |
scopes[] |
Solo salida. Es la lista de permisos que estarán disponibles para esta cuenta de servicio. El CLH lo establece en https://www.googleapis.com/auth/cloud-platform. |
VmImage
Es la definición de una imagen personalizada de máquina virtual de Compute Engine para iniciar una instancia de notebook con el entorno instalado directamente en la VM.
| Representación JSON |
|---|
{ "project": string, // Union field |
| Campos | |
|---|---|
project |
Obligatorio. Es el nombre del proyecto de Google Cloud al que pertenece esta imagen de VM. Formato: |
Campo de unión image. Es la referencia a una imagen de VM externa de Compute Engine. image puede ser solo uno de los parámetros siguientes: |
|
name |
Es opcional. Usa el nombre de la imagen de VM para encontrarla. |
family |
Es opcional. Usa esta familia de imágenes de VM para encontrar la imagen. Se usará la imagen más reciente de esta familia. |
ContainerImage
Es la definición de una imagen de contenedor para iniciar una instancia de notebook con el entorno instalado en un contenedor.
| Representación JSON |
|---|
{ "repository": string, "tag": string } |
| Campos | |
|---|---|
repository |
Obligatorio. Es la ruta de acceso al repositorio de imágenes de contenedor. Por ejemplo: |
tag |
Es opcional. Es la etiqueta de la imagen del contenedor. Si no se especifica, el valor predeterminado es la etiqueta más reciente. |
BootDisk
Es la definición de un disco de arranque.
| Representación JSON |
|---|
{ "diskSizeGb": string, "diskType": enum ( |
| Campos | |
|---|---|
diskSizeGb |
Es opcional. Tamaño del disco de arranque en GB asociado a esta instancia, hasta un máximo de 64,000 GB (64 TB). Si no se especifica, se usará el valor recomendado de 150 GB. |
diskType |
Es opcional. Indica el tipo de disco. |
diskEncryption |
Es opcional. Solo entrada. Es el método de encriptación de disco que se usa en los discos de arranque y de datos. El valor predeterminado es GMEK. |
kmsKey |
Es opcional. Solo entrada. Es la clave de KMS que se usa para encriptar los discos. Solo se aplica si diskEncryption es CMEK. Formato: Obtén más información para usar tus propias claves de encriptación. |
DiskType
Son los tipos de discos posibles.
| Enums | |
|---|---|
DISK_TYPE_UNSPECIFIED |
No se estableció el tipo de disco. |
PD_STANDARD |
Es el tipo de disco persistente estándar. |
PD_SSD |
Es el tipo de disco persistente SSD. |
PD_BALANCED |
Es el tipo de disco persistente balanceado. |
PD_EXTREME |
Es el tipo de disco persistente extremo. |
HYPERDISK_BALANCED |
Representa el tipo de disco persistente Hyperdisk Balanced. Se puede usar como disco de arranque o disco de datos. |
HYPERDISK_EXTREME |
Representa el tipo de disco persistente Hyperdisk Extreme. Solo se puede usar como disco de datos. |
HYPERDISK_THROUGHPUT |
Representa el tipo de disco persistente Hyperdisk Throughput. Solo se puede usar como disco de datos. |
HYPERDISK_BALANCED_HIGH_AVAILABILITY |
Representa el tipo de disco persistente Hyperdisk Balanced High Availability. Se puede usar como disco de arranque o disco de datos. |
HYPERDISK_ML |
Representa el tipo de disco persistente Hyperdisk ML. Se puede usar como disco de arranque o disco de datos. |
DiskEncryption
Es la definición de las opciones de encriptación de disco.
| Enums | |
|---|---|
DISK_ENCRYPTION_UNSPECIFIED |
No se especificó la encriptación de disco. |
GMEK |
Usa claves de encriptación administradas por Google para encriptar el disco de arranque. |
CMEK |
Usa claves de encriptación administradas por el cliente para encriptar el disco de arranque. |
DataDisk
Es un recurso de disco conectado a una instancia.
| Representación JSON |
|---|
{ "diskSizeGb": string, "diskType": enum ( |
| Campos | |
|---|---|
diskSizeGb |
Es opcional. Tamaño del disco en GB conectado a esta instancia de VM, hasta un máximo de 64,000 GB (64 TB). Si no se especifica, el valor predeterminado es 100. |
diskType |
Es opcional. Solo entrada. Indica el tipo de disco. |
diskEncryption |
Es opcional. Solo entrada. Es el método de encriptación de disco que se usa en los discos de arranque y de datos. El valor predeterminado es GMEK. |
kmsKey |
Es opcional. Solo entrada. Es la clave de KMS que se usa para encriptar los discos. Solo se aplica si diskEncryption es CMEK. Formato: Obtén más información para usar tus propias claves de encriptación. |
resourcePolicies[] |
Es opcional. Son las políticas de recursos que se aplicarán al disco de datos. |
ShieldedInstanceConfig
Es un conjunto de opciones de instancias protegidas. Consulta Imágenes que usan características compatibles de VM protegida. No todas las combinaciones son válidas.
| Representación JSON |
|---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
| Campos | |
|---|---|
enableSecureBoot |
Es opcional. Define si la instancia de VM tiene habilitado el inicio seguro. El inicio seguro ayuda a garantizar que el sistema solo ejecute software auténtico a través de la verificación de la firma digital de todos los componentes del inicio y la detención del proceso de inicio si falla la verificación de la firma. Está inhabilitado de forma predeterminada. |
enableVtpm |
Es opcional. Define si la instancia de VM tiene habilitado el vTPM. |
enableIntegrityMonitoring |
Es opcional. Define si la instancia de VM tiene habilitada la supervisión de integridad. Habilita la supervisión y la certificación de la integridad de inicio de la instancia de VM. La certificación se realiza según el modelo de referencia de la política de integridad. Este modelo de referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia de VM. |
NetworkInterface
Es la definición de un recurso de interfaz de red conectado a una VM.
| Representación JSON |
|---|
{ "network": string, "subnet": string, "nicType": enum ( |
| Campos | |
|---|---|
network |
Es opcional. Es el nombre de la VPC en la que se encuentra esta instancia de VM. Formato: |
subnet |
Es opcional. Es el nombre de la subred en la que se encuentra esta instancia de VM. Formato: |
nicType |
Es opcional. Es el tipo de vNIC que se usará en esta interfaz. Puede ser gVNIC o VirtioNet. |
accessConfigs[] |
Es opcional. Es un array de configuraciones para esta interfaz. Actualmente, solo se admite una configuración de acceso, ONE_TO_ONE_NAT. Si no se especifica ningún accessConfigs, la instancia tendrá acceso externo a Internet a través de una dirección IP externa efímera. |
NicType
Es el tipo de controlador de vNIC. El valor predeterminado debe ser NIC_TYPE_UNSPECIFIED.
| Enums | |
|---|---|
NIC_TYPE_UNSPECIFIED |
No se especificó ningún tipo. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
AccessConfig
Es una configuración de acceso adjunta a la interfaz de red de una instancia.
| Representación JSON |
|---|
{ "externalIp": string } |
| Campos | |
|---|---|
externalIp |
Una dirección IP externa asociada con esta instancia. Especifica una dirección IP externa estática sin usar que esté disponible para el proyecto o deja este campo sin definir para usar una IP de un grupo compartido de direcciones IP efímeras. Si especificas una dirección IP externa estática, esta debe estar en la misma región que la zona de la instancia. |
GPUDriverConfig
Una configuración del controlador de GPU
| Representación JSON |
|---|
{ "enableGpuDriver": boolean, "customGpuDriverPath": string } |
| Campos | |
|---|---|
enableGpuDriver |
Es opcional. Indica si el usuario final autoriza a Google Cloud a instalar el controlador de GPU en esta instancia de VM. Si este campo está vacío o se establece como falso, no se instalará el controlador de la GPU. Solo se aplica a las instancias con GPU. |
customGpuDriverPath |
Es opcional. Especifica una ruta de acceso personalizada de Cloud Storage en la que se almacena el controlador de GPU. Si no se especifica, elegiremos automáticamente entre los controladores oficiales de la GPU. |
ConfidentialInstanceConfig
Es un conjunto de opciones de instancias confidenciales.
| Representación JSON |
|---|
{
"confidentialInstanceType": enum ( |
| Campos | |
|---|---|
confidentialInstanceType |
Es opcional. Define el tipo de tecnología que usa la instancia confidencial. |
ConfidentialInstanceType
Es el tipo de instancia confidencial.
| Enums | |
|---|---|
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED |
No se especificó ningún tipo. No uses este valor. |
SEV |
Virtualización segura encriptada de AMD |
Estado
Es la definición de los estados de esta instancia.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
No se especificó el estado. |
STARTING |
La lógica de control está iniciando la instancia. |
PROVISIONING |
La lógica de control instala los frameworks necesarios y registra la instancia con el proxy de notebook. |
ACTIVE |
Indica que la instancia está en ejecución. |
STOPPING |
La lógica de control está deteniendo la instancia. |
STOPPED |
Se detuvo la instancia. |
DELETED |
Se borró la instancia. |
UPGRADING |
La instancia se está actualizando. |
INITIALIZING |
Se está creando la instancia. |
SUSPENDING |
La instancia se está suspendiendo. |
SUSPENDED |
La instancia está suspendida. |
UpgradeHistoryEntry
Es la entrada del historial de actualización de la imagen de VM.
| Representación JSON |
|---|
{ "snapshot": string, "vmImage": string, "containerImage": string, "framework": string, "version": string, "state": enum ( |
| Campos | |
|---|---|
snapshot |
Es opcional. Es la instantánea del disco de arranque de esta instancia de notebook antes de la actualización. |
vmImage |
Es opcional. Es la imagen de la VM antes de la actualización de esta instancia. |
containerImage |
Es opcional. Es la imagen del contenedor antes de la actualización de esta instancia. |
framework |
Es opcional. Es el framework de esta instancia de notebook. |
version |
Es opcional. Es la versión de la instancia de notebook antes de esta actualización. |
state |
Solo salida. Es el estado de esta entrada del historial de actualizaciones de instancias. |
createTime |
Inmutable. Es la fecha y hora en que se creó esta entrada del historial de actualizaciones de la instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
action |
Es opcional. Acción. Revertir o actualizar. |
targetVersion |
Es opcional. Versión de la VM de destino, como m63. |
Estado
Es la definición de los estados de esta entrada del historial de actualizaciones.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
No se especificó el estado. |
STARTED |
Se inició la actualización de la instancia. |
SUCCEEDED |
La actualización de la instancia se completó correctamente. |
FAILED |
No se pudo actualizar la instancia. |
Acción
Es la definición de las operaciones de esta entrada del historial de actualización.
| Enums | |
|---|---|
ACTION_UNSPECIFIED |
No se especificó la operación. |
UPGRADE |
Actualiza. |
ROLLBACK |
Reversión. |
HealthState
Es el estado de la instancia.
| Enums | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
Se desconoce el subestado de la instancia. |
HEALTHY |
Se sabe que la instancia está en buen estado (por ejemplo, los daemons críticos se están ejecutando). Se aplica al estado ACTIVE. |
UNHEALTHY |
Se sabe que la instancia está en mal estado (por ejemplo, no se están ejecutando los daemons críticos). Se aplica al estado ACTIVE. |
AGENT_NOT_INSTALLED |
La instancia no tiene instalado el agente de supervisión de estado. Se aplica al estado ACTIVE. |
AGENT_NOT_RUNNING |
El agente de supervisión del estado de la instancia no se está ejecutando. Se aplica al estado ACTIVE. |
Métodos |
|
|---|---|
|
Comprueba si se puede actualizar una instancia de notebook. |
|
Crea una instancia nueva en un proyecto y una ubicación determinados. |
|
Borra una sola instancia. |
|
Crea un archivo de diagnóstico y ejecuta la herramienta de diagnóstico para una instancia determinada. |
|
Obtiene los detalles de una sola instancia. |
|
Devuelve varios parámetros de configuración. |
|
Permite obtener la política de control de acceso de un recurso. |
|
Enumera instancias en una ubicación y un proyecto determinados. |
|
UpdateInstance actualiza una instancia. |
|
Restablece una instancia de notebook. |
|
Cambia el tamaño del disco de una instancia de notebook a una capacidad mayor. |
|
RestoreInstance restablece una instancia a partir de un BackupSource. |
|
Revierte una instancia de notebook a la versión anterior. |
|
Permite configurar la política de control de acceso en el recurso especificado. |
|
Inicia una instancia de notebook. |
|
Detiene una instancia de notebook. |
|
Permite mostrar los permisos que tiene un emisor para un recurso específico. |
|
Actualiza una instancia de notebook a la versión más reciente. |