Recurso: Instancia
Es la definición de una instancia de notebook.
| Representación JSON |
|---|
{ "name": string, "postStartupScript": string, "proxyUri": string, "instanceOwners": [ string ], "serviceAccount": string, "serviceAccountScopes": [ string ], "machineType": string, "acceleratorConfig": { object ( |
| Campos | |
|---|---|
name |
Solo salida. Es el nombre de esta instancia de notebook. Formato: |
postStartupScript |
Ruta de acceso a una secuencia de comandos de Bash que se ejecuta automáticamente después de que se inicia por completo una instancia de notebook. La ruta de acceso debe ser una URL o una ruta de Cloud Storage ( |
proxyUri |
Solo salida. Es el extremo del proxy que se usa para acceder al notebook de Jupyter. |
instanceOwners[] |
Solo entrada. 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. |
serviceAccount |
La cuenta de servicio en esta instancia, que otorga acceso a otros servicios de Google Cloud. Puedes usar cualquier cuenta de servicio en el mismo proyecto, pero debes tener el permiso de usuario de la cuenta de servicio para usar la instancia. Si no se especifica, se usa la cuenta de servicio predeterminada de Compute Engine. |
serviceAccountScopes[] |
Es opcional. Son los URIs de los permisos de acceso de la cuenta de servicio que se incluirán en las instancias de Compute Engine. Si no se especifican, se definen los siguientes permisos: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Si no usas los permisos predeterminados, necesitas al menos: https://www.googleapis.com/auth/compute |
machineType |
Obligatorio. Es el tipo de máquina de Compute Engine de esta instancia. |
acceleratorConfig |
Es el acelerador de hardware que se usa en esta instancia. Si usas aceleradores, asegúrate de que tu configuración tenga suficientes CPU virtuales y memoria para admitir el |
state |
Solo salida. Es el estado de esta instancia. |
installGpuDriver |
Indica si el usuario final autoriza a Google Cloud a instalar el controlador de GPU en esta instancia. Si este campo está vacío o se establece como falso, no se instalará el controlador de GPU. Solo se aplica a instancias con GPUs. |
customGpuDriverPath |
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. |
bootDiskType |
Solo entrada. Tipo de disco de arranque conectado a esta instancia. El valor predeterminado es disco persistente estándar ( |
bootDiskSizeGb |
Solo entrada. Tamaño del disco de arranque en GB conectado a esta instancia, hasta un máximo de 64,000 GB (64 TB). El valor mínimo recomendado es de 100 GB. Si no se especifica, el valor predeterminado es 100. |
dataDiskType |
Solo entrada. Es el tipo de disco de datos conectado a esta instancia. El valor predeterminado es disco persistente estándar ( |
dataDiskSizeGb |
Solo entrada. Tamaño del disco de datos en GB conectado a esta instancia, hasta un máximo de 64,000 GB (64 TB). Puedes elegir el tamaño del disco de datos según el tamaño de tus notebooks y datos. Si no se especifica, el valor predeterminado es 100. |
noRemoveDataDisk |
Solo entrada. Si es verdadero, el disco de datos no se borrará automáticamente cuando se borre la instancia. |
diskEncryption |
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 |
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. |
disks[] |
Solo salida. Son los discos conectados a la instancia de notebook. |
shieldedInstanceConfig |
Es opcional. Configuración de VM protegida. Imágenes que usan funciones compatibles de VM protegida |
noPublicIp |
Si es verdadero, no se asignará ninguna IP externa a esta instancia. |
noProxyAccess |
Si es verdadero, la instancia del notebook no se registrará en el proxy. |
network |
Es el nombre de la VPC en la que se encuentra esta instancia. Formato: |
subnet |
Es el nombre de la subred en la que se encuentra esta instancia. Formato: |
labels |
Son las etiquetas que se aplicarán a esta instancia. Estos se pueden modificar más adelante con el método setLabels. Un objeto que contiene una lista de pares |
metadata |
Son los metadatos personalizados que se aplicarán a esta instancia. Por ejemplo, para especificar un bucket de Cloud Storage para la copia de seguridad automática, puedes usar la etiqueta de metadatos Un objeto que contiene una lista de pares |
tags[] |
Es opcional. Son las etiquetas de red de Compute Engine que se agregarán en el tiempo de ejecución (consulta Agrega etiquetas de red). |
upgradeHistory[] |
Es el historial de actualizaciones de esta instancia. |
nicType |
Es opcional. Es el tipo de vNIC que se usará en esta interfaz. Puede ser gVNIC o VirtioNet. |
reservationAffinity |
Es opcional. Es la afinidad de reserva opcional. Si configuras este campo, se aplicará la reserva de procesamiento zonal especificada a esta instancia de notebook. |
creator |
Solo salida. Dirección de correo electrónico de la entidad que envió la solicitud original de instances.create. |
canIpForward |
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 |
createTime |
Solo salida. Es la 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: |
instanceMigrationEligibility |
Solo salida. Verifica qué tan factible es una migración de UmN a WbI. |
| Tipo de entorno. Puede ser una imagen de VM o una imagen de contenedor. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
vmImage |
Usa una imagen de VM de Compute Engine para iniciar la instancia del notebook. |
containerImage |
Usa una imagen de contenedor para iniciar la instancia del notebook. |
| Fin de los campos mutuamente excluyentes. | |
migrated |
Solo salida. Es un valor booleano que indica si este notebook se migró a una instancia de Workbench. |
AcceleratorConfig
Es la definición de un acelerador de hardware. Ten en cuenta que no todas las combinaciones de type y coreCount son válidas. Consulta GPU en Compute Engine para encontrar una combinación válida. Las TPU no son compatibles.
| Representación JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Es el tipo de acelerador. |
coreCount |
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_K80 |
El tipo de acelerador es Nvidia Tesla K80. |
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. |
NVIDIA_L4 |
El tipo de acelerador es Nvidia Tesla L4. |
NVIDIA_A100_80GB |
El tipo de acelerador es Nvidia Tesla A100 de 80 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_H100_80GB |
El tipo de acelerador es NVIDIA H100 de 80 GB. |
NVIDIA_H100_MEGA_80GB |
El tipo de acelerador es NVIDIA H100 Mega de 80 GB. |
TPU_V2 |
(Próximamente) El tipo de acelerador es TPU V2. |
TPU_V3 |
(Próximamente) El tipo de acelerador es TPU V3. |
Estado
Es la definición de los estados de esta instancia.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
No se especifica el estado. |
STARTING |
La lógica de control está iniciando la instancia. |
PROVISIONING |
La lógica de control instala los frameworks requeridos 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. |
REGISTERING |
Se está registrando la instancia. |
SUSPENDING |
La instancia se está suspendiendo. |
SUSPENDED |
La instancia está suspendida. |
DiskType
Son los tipos de discos posibles para las instancias de notebook.
| 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. |
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. |
Disco
Es un recurso de disco conectado a una instancia.
| Representación JSON |
|---|
{
"autoDelete": boolean,
"boot": boolean,
"deviceName": string,
"diskSizeGb": string,
"guestOsFeatures": [
{
object ( |
| Campos | |
|---|---|
autoDelete |
Indica si el disco se borrará automáticamente cuando se borre la instancia (pero no cuando se separe el disco de la instancia). |
boot |
Indica que este es un disco de arranque. La máquina virtual usará la primera partición del disco para su sistema de archivos raíz. |
deviceName |
Indica un nombre de dispositivo único de tu elección que se refleja en el árbol Si no se especifica, el servidor elige un nombre de dispositivo predeterminado para aplicar a este disco, con el formato persistent-disk-x, en el que x es un número asignado por Google Compute Engine.Este campo solo se aplica a los discos persistentes. |
diskSizeGb |
Indica el tamaño del disco en GB base 2. |
guestOsFeatures[] |
Indica una lista de funciones para habilitar en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. |
index |
Es un índice basado en cero para este disco, en el que el 0 está reservado para el disco de arranque. Si tienes muchos discos conectados a una instancia, cada uno tendrá un número de índice único. |
interface |
Indica la interfaz de disco que se usará para conectar este disco, que puede ser SCSI o NVMe. El valor predeterminado es SCSI. Los discos persistentes siempre deben usar SCSI, y la solicitud fallará si intentas adjuntar un disco persistente en cualquier otro formato que no sea SCSI. Las SSD locales pueden usar NVMe o SCSI. Para conocer las características de rendimiento de SCSI a través de NVMe, consulta Rendimiento de SSD locales. Valores válidos:
|
kind |
Tipo de recurso. Siempre calcula#attachedDisk para los discos conectados. |
licenses[] |
Es una lista de licencias visibles públicamente. Reservado para el uso de Google. Una licencia representa los datos de facturación y de uso agregados para las imágenes públicas y de Marketplace. |
mode |
Es el modo en el que se conectará este disco, ya sea
|
source |
Indica una URL parcial o completa válida para un recurso de Persistent Disk existente. |
type |
Indica el tipo de disco, ya sea
|
GuestOsFeature
Son las funciones del SO invitado para el disco de arranque.
| Representación JSON |
|---|
{ "type": string } |
| Campos | |
|---|---|
type |
Es el ID de una función admitida. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. Valores válidos:
|
ShieldedInstanceConfig
Es un conjunto de opciones de instancias protegidas. Consulta Imágenes que usan funciones compatibles de VM protegida. No todas las combinaciones son válidas.
| Representación JSON |
|---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
| Campos | |
|---|---|
enableSecureBoot |
Define si la instancia tiene habilitado el inicio seguro. El arranque 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 |
Define si la instancia tiene habilitado el vTPM. Habilitada de forma predeterminada. |
enableIntegrityMonitoring |
Define si la instancia tiene habilitada la supervisión de integridad. Habilita la supervisión y la certificación de la integridad del inicio de la instancia. La certificación se realiza en función del modelo de referencia de la política de integridad. Este valor de referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia. Habilitada de forma predeterminada. |
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 la instantánea del disco de arranque de esta instancia de notebook antes de la actualización. |
vmImage |
Es la imagen de la VM antes de la actualización de esta instancia. |
containerImage |
Es la imagen del contenedor antes de la actualización de la instancia. |
framework |
Es el framework de esta instancia de notebook. |
version |
Es la versión de la instancia de notebook anterior a esta actualización. |
state |
Es el estado de esta entrada del historial de actualizaciones de instancias. |
createTime |
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: |
targetImage |
Es la imagen de VM de destino. Formato: |
action |
Acción. Revertir o actualizar |
targetVersion |
Versión de la VM de destino, como m63. |
Estado
Es la definición de los estados de esta entrada del historial de actualización.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
No se especifica 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 |
Es una reversión. |
NicType
Es el tipo de controlador de la NIC virtual. El valor predeterminado debe ser UNSPECIFIED_NIC_TYPE.
| Enums | |
|---|---|
UNSPECIFIED_NIC_TYPE |
No se especificó ningún tipo. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
ReservationAffinity
Es la afinidad de reserva para consumir la reserva zonal.
| Representación JSON |
|---|
{
"consumeReservationType": enum ( |
| Campos | |
|---|---|
consumeReservationType |
Es opcional. Tipo de reserva que se consumirá |
key |
Es opcional. Corresponde a la clave de etiqueta del recurso de reserva. |
values[] |
Es opcional. Corresponde a los valores de etiqueta del recurso de reserva. |
Tipo
Indica si se debe consumir capacidad de una reserva o no.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Es el tipo predeterminado. |
NO_RESERVATION |
No consumen capacidad asignada. |
ANY_RESERVATION |
Consume cualquier reserva disponible. |
SPECIFIC_RESERVATION |
Debe consumir recursos de una reserva específica. Se deben especificar los campos de clave-valor para especificar las reservaciones. |
InstanceMigrationEligibility
InstanceMigrationEligibility representa la información de viabilidad de una migración de UmN a WbI.
| Representación JSON |
|---|
{ "warnings": [ enum ( |
| Campos | |
|---|---|
warnings[] |
Solo salida. Durante la migración, se establecerán ciertos parámetros de configuración de forma predeterminada. |
errors[] |
Solo salida. Algunos parámetros de configuración hacen que la UmN no sea apta para una migración automática. Se requiere una migración manual. |
Advertencia
Un mensaje de advertencia de migración significa que ciertos parámetros de configuración se establecerán de forma predeterminada durante la migración.
| Enums | |
|---|---|
WARNING_UNSPECIFIED |
Es el tipo predeterminado. |
UNSUPPORTED_MACHINE_TYPE |
La UmN usa un tipo de máquina que no es compatible con WbI. Se migrará con el tipo de máquina predeterminado e2-standard-4. Los usuarios pueden cambiar el tipo de máquina después de la migración. |
UNSUPPORTED_ACCELERATOR_TYPE |
El UmN usa un tipo de acelerador que no se admite en WbI. Se migrará sin un acelerador. El usuario puede adjuntar un acelerador después de la migración. |
UNSUPPORTED_OS |
La UmN usa un sistema operativo que no es compatible con la WbI (p.ej., Debian 10, Ubuntu). Se reemplazará por Debian 11 en WbI. |
NO_REMOVE_DATA_DISK |
Este UmN está configurado con noRemoveDataDisk, que ya no está disponible en WbI. |
GCS_BACKUP |
Este UmN se configuró con la función de copia de seguridad de Cloud Storage, que ya no está disponible en WbI. |
POST_STARTUP_SCRIPT |
Este UmN está configurado con una secuencia de comandos posterior al inicio. De manera opcional, proporciona el postStartupScriptOption para la migración. |
Error
Un mensaje de error de migración significa que ciertos parámetros de configuración hacen que UmN no sea apto para una migración automática. Se requiere una migración manual.
| Enums | |
|---|---|
ERROR_UNSPECIFIED |
Es el tipo predeterminado. |
DATAPROC_HUB |
El UmN usa Dataproc Hub y no se puede migrar. |
Métodos |
|
|---|---|
|
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. |
|
Permite obtener la política de control de acceso de un recurso. |
|
Verifica si una instancia de notebook está en buen estado. |
|
Comprueba si una instancia de notebook se puede actualizar. |
|
Enumera las instancias en una ubicación y un proyecto determinados. |
|
Migra un notebook administrado por el usuario existente a instancias de Workbench. |
|
Registra una instancia de notebook heredada existente en el servidor de la API de Notebooks. |
|
Permite que las instancias de notebook informen su información más reciente al servidor de la API de Notebooks. |
|
Restablece una instancia de notebook. |
|
Revierte una instancia de notebook a la versión anterior. |
|
Actualiza los aceleradores de invitado de una sola instancia. |
|
Permite configurar la política de control de acceso en el recurso especificado. |
|
Reemplaza todas las etiquetas de una instancia. |
|
Actualiza el tipo de máquina de una sola instancia. |
|
Inicia una instancia de notebook. |
|
Detiene una instancia de notebook. |
|
Permite mostrar los permisos que tiene un emisor para un recurso específico. |
|
Se actualizó la configuración de las instancias de notebook. |
|
Agrega o actualiza elementos de metadatos para una instancia. |
|
Actualiza la configuración de instancia protegida de una sola instancia. |
|
Actualiza una instancia de notebook a la versión más reciente. |