REST Resource: projects.locations.runtimes

Ressource : Runtime

Définition d'un environnement d'exécution pour une instance de notebook géré.

Représentation JSON
{
  "name": string,
  "state": enum (State),
  "healthState": enum (HealthState),
  "accessConfig": {
    object (RuntimeAccessConfig)
  },
  "softwareConfig": {
    object (RuntimeSoftwareConfig)
  },
  "metrics": {
    object (RuntimeMetrics)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeMigrationEligibility": {
    object (RuntimeMigrationEligibility)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "virtualMachine": {
    object (VirtualMachine)
  }
  // End of mutually exclusive fields.
  "migrated": boolean
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'environnement d'exécution. Format : projects/{project}/locations/{location}/runtimes/{runtimeId}

state

enum (State)

Uniquement en sortie. État de l'exécution.

healthState

enum (HealthState)

Uniquement en sortie. healthState de l'exécution.

accessConfig

object (RuntimeAccessConfig)

Paramètres de configuration pour accéder au runtime.

softwareConfig

object (RuntimeSoftwareConfig)

Paramètres de configuration du logiciel dans l'environnement d'exécution.

metrics

object (RuntimeMetrics)

Uniquement en sortie. Contient les métriques du daemon Runtime, telles que l'état du service et les statistiques JupyterLab.

createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de l'exécution.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure de mise à jour de l'environnement d'exécution.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Facultatif. Libellés à associer à ce notebook géré ou à cet environnement d'exécution. Les clés des libellés doivent comporter entre 1 et 63 caractères, et être conformes à la norme RFC 1035. Les valeurs des libellés peuvent être vides, mais, si elles sont présentes, elles doivent contenir entre 1 et 63 caractères et être conformes à la norme RFC 1035. Un cluster ne peut pas être associé à plus de 32 libellés.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runtimeMigrationEligibility

object (RuntimeMigrationEligibility)

Uniquement en sortie. Vérifie la faisabilité d'une migration de GmN vers WbI.

Type du runtime. Actuellement, seule la VM Compute Engine est acceptée. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
virtualMachine

object (VirtualMachine)

Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook gérée.

Fin des champs qui s'excluent mutuellement.
migrated

boolean

Uniquement en sortie. Booléen indiquant si ce notebook a été migré vers une instance Workbench

VirtualMachine

Environnement d'exécution utilisant une machine virtuelle pour le calcul.

Représentation JSON
{
  "instanceName": string,
  "instanceId": string,
  "virtualMachineConfig": {
    object (VirtualMachineConfig)
  }
}
Champs
instanceName

string

Uniquement en sortie. Nom convivial de l'instance Compute Engine gérée.

instanceId

string

Uniquement en sortie. Identifiant unique de l'instance Compute Engine gérée.

virtualMachineConfig

object (VirtualMachineConfig)

Paramètres de configuration des machines virtuelles.

VirtualMachineConfig

Paramètres de configuration de la machine virtuelle.

Représentation JSON
{
  "zone": string,
  "machineType": string,
  "containerImages": [
    {
      object (ContainerImage)
    }
  ],
  "dataDisk": {
    object (LocalDisk)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "shieldedInstanceConfig": {
    object (RuntimeShieldedInstanceConfig)
  },
  "acceleratorConfig": {
    object (RuntimeAcceleratorConfig)
  },
  "network": string,
  "subnet": string,
  "internalIpOnly": boolean,
  "tags": [
    string
  ],
  "guestAttributes": {
    string: string,
    ...
  },
  "metadata": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "nicType": enum (NicType),
  "reservedIpRange": string,
  "bootImage": {
    object (BootImage)
  }
}
Champs
zone

string

Uniquement en sortie. Zone dans laquelle se trouve la machine virtuelle. Si vous utilisez une requête régionale, le service Notebooks choisira un emplacement dans la région d'exécution correspondante. Lors d'une requête GET, la zone sera toujours présente. Exemple : * us-central1-b

machineType

string

Obligatoire. Type de machine Compute Engine utilisé pour les environnements d'exécution. Le nom court est valide. Exemples : * n1-standard-2 * e2-standard-8

containerImages[]

object (ContainerImage)

Facultatif. Utilisez une liste d'images de conteneurs à utiliser comme noyaux dans l'instance de notebook.

dataDisk

object (LocalDisk)

Obligatoire. Paramètres de configuration de l'option de disque de données.

encryptionConfig

object (EncryptionConfig)

Facultatif. Paramètres de chiffrement du disque de données de la machine virtuelle.

shieldedInstanceConfig

object (RuntimeShieldedInstanceConfig)

Facultatif. Paramètres de configuration des instances de VM protégées.

acceleratorConfig

object (RuntimeAcceleratorConfig)

Facultatif. Configuration de l'accélérateur Compute Engine pour cet environnement d'exécution.

network

string

Facultatif. Réseau Compute Engine à utiliser pour les communications entre les machines. Ne peut pas être spécifié avec un sous-réseau. Si ni network ni subnet ne sont spécifiés, le réseau "par défaut" du projet est utilisé, s'il existe.

URL complète ou URI partiel. Exemples :

  • https://www.googleapis.com/compute/v1/projects/[projectId]/global/networks/default
  • projects/[projectId]/global/networks/default

Les runtimes sont des ressources gérées dans l'infrastructure Google. Les environnements d'exécution sont compatibles avec les configurations réseau suivantes :

  • Réseau géré par Google (le réseau et le sous-réseau sont vides)
  • VPC du projet consommateur (réseau et sous-réseau obligatoires). Nécessite la configuration de l'accès aux services privés.
  • VPC partagé (réseau et sous-réseau obligatoires) Nécessite la configuration de l'accès aux services privés.
subnet

string

Facultatif. Sous-réseau Compute Engine à utiliser pour les communications entre les machines. Ne peut pas être spécifié avec le réseau.

Une URL complète ou un URI partiel sont valides. Exemples :

  • https://www.googleapis.com/compute/v1/projects/[projectId]/regions/us-east1/subnetworks/sub0
  • projects/[projectId]/regions/us-east1/subnetworks/sub0
internalIpOnly

boolean

Facultatif. Si la valeur est "true", le runtime ne disposera que d'adresses IP internes. Par défaut, les runtimes ne sont pas limités aux adresses IP internes et des adresses IP externes éphémères sont attribuées à chaque VM. Cette restriction internalIpOnly ne peut être activée que pour les réseaux avec sous-réseau activé, et toutes les dépendances doivent être configurées pour être accessibles sans adresse IP externe.

tags[]

string

Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau).

guestAttributes

map (key: string, value: string)

Uniquement en sortie. Attributs invité Compute Engine. (voir Attributs d'invité du projet et de l'instance).

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metadata

map (key: string, value: string)

Facultatif. Entrées de métadonnées Compute Engine à ajouter à la machine virtuelle. (voir Métadonnées de projet et d'instance).

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

labels

map (key: string, value: string)

Facultatif. Libellés à associer à ce runtime. Les clés des libellés doivent comporter entre 1 et 63 caractères, et être conformes à la norme RFC 1035. Les valeurs des libellés peuvent être vides, mais, si elles sont présentes, elles doivent contenir entre 1 et 63 caractères et être conformes à la norme RFC 1035. Un cluster ne peut pas être associé à plus de 32 libellés.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

nicType

enum (NicType)

Facultatif. Type de carte d'interface réseau virtuelle à utiliser sur cette interface. Il peut s'agir de gVNIC ou de VirtioNet.

reservedIpRange

string

Facultatif. Le nom de la plage d'adresses IP réservée est utilisé pour l'appairage de VPC. L'allocation de sous-réseau se servira du nom de la plage si celui-ci est attribué.

Exemple : managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

La valeur du champ sera : managed-notebooks-range-c

bootImage

object (BootImage)

Facultatif. Métadonnées de l'image de démarrage utilisées pour la mise à niveau de l'environnement d'exécution.

LocalDisk

Ressource de disque local associé.

Représentation JSON
{
  "autoDelete": boolean,
  "boot": boolean,
  "deviceName": string,
  "guestOsFeatures": [
    {
      object (RuntimeGuestOsFeature)
    }
  ],
  "index": integer,
  "initializeParams": {
    object (LocalDiskInitializeParams)
  },
  "interface": string,
  "kind": string,
  "licenses": [
    string
  ],
  "mode": string,
  "source": string,
  "type": string
}
Champs
autoDelete

boolean

Facultatif. Uniquement en sortie. Indique si le disque sera supprimé automatiquement lorsque l'instance sera supprimée (mais pas lorsque le disque sera dissocié de l'instance).

boot

boolean

Facultatif. Uniquement en sortie. Indique qu'il s'agit d'un disque de démarrage. La machine virtuelle utilisera la première partition du disque pour son système de fichiers racine.

deviceName

string

Facultatif. Uniquement en sortie. Spécifie un nom d'appareil unique de votre choix qui est reflété dans l'arborescence /dev/disk/by-id/google-* d'un système d'exploitation Linux exécuté dans l'instance. Ce nom peut être utilisé pour faire référence à l'appareil depuis l'instance au cours des processus de montage ou de redimensionnement, par exemple.

Si vous ne spécifiez pas de nom d'appareil, le serveur choisit un nom d'appareil par défaut à appliquer à ce disque, au format persistent-disk-x, où x est un numéro attribué par Google Compute Engine. Ce champ ne s'applique qu'aux disques persistants.

guestOsFeatures[]

object (RuntimeGuestOsFeature)

Uniquement en sortie. Indique une liste de fonctionnalités à activer sur le système d'exploitation invité. Applicable uniquement aux images amorçables. Consultez la section "Activer des fonctionnalités d'un système d'exploitation invité" pour obtenir la liste des options disponibles.

index

integer

Uniquement en sortie. Index basé sur zéro pour ce disque, où 0 est réservé au disque de démarrage. Si plusieurs disques sont associés à une instance, chacun d'eux possède un numéro d'index unique.

initializeParams

object (LocalDiskInitializeParams)

Uniquement en entrée. Spécifie les paramètres d'un nouveau disque qui sera créé en même temps que la nouvelle instance. Utilisez des paramètres d'initialisation pour créer des disques de démarrage ou des disques SSD locaux associés à la nouvelle instance.

Cette propriété s'exclut mutuellement avec la propriété source. Vous ne pouvez définir que l'une ou l'autre, mais pas les deux.

interface

string

Spécifie l'interface de disque à utiliser pour associer ce disque (SCSI ou NVMe). La valeur par défaut est SCSI. Les disques persistants doivent toujours utiliser SCSI. La requête échouera si vous tentez d'associer un disque persistant dans un autre format que SCSI. Les disques SSD locaux peuvent utiliser NVMe ou SCSI. Pour connaître les caractéristiques de performances de SCSI sur NVMe, consultez "Performances des disques SSD locaux". Valeurs correctes :

  • NVME
  • SCSI
kind

string

Uniquement en sortie. Type de la ressource. Calculez toujours compute#attachedDisk pour les disques associés.

licenses[]

string

Uniquement en sortie. Toutes les licences valides et visibles publiquement.

mode

string

Mode d'association de ce disque, READ_WRITE ou READ_ONLY. Si aucune valeur n'est spécifiée, le disque est associé en mode READ_WRITE par défaut. Valeurs correctes :

  • READ_ONLY
  • READ_WRITE
source

string

Spécifie une URL partielle ou complète valide vers une ressource de disque persistant existante.

type

string

Spécifie le type de disque, SCRATCH ou PERSISTENT. Si aucune valeur n'est spécifiée, la valeur par défaut est PERSISTENT. Valeurs correctes :

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

Facultatif. Liste des fonctionnalités à activer sur le système d'exploitation invité. Applicable uniquement aux images amorçables. Consultez Activer les fonctionnalités du système d'exploitation invité pour obtenir la liste des options disponibles. Fonctionnalités de l'OS invité pour le disque de démarrage.

Représentation JSON
{
  "type": string
}
Champs
type

string

ID d'une fonctionnalité compatible. Consultez Activer les fonctionnalités du système d'exploitation invité pour obtenir la liste des options disponibles.

Valeurs correctes :

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

LocalDiskInitializeParams

Uniquement en entrée. Spécifie les paramètres d'un nouveau disque qui sera créé en même temps que la nouvelle instance. Utilisez des paramètres d'initialisation pour créer des disques de démarrage ou des disques SSD locaux associés au nouveau runtime. Cette propriété s'exclut mutuellement avec la propriété source. Vous ne pouvez définir que l'une ou l'autre, mais pas les deux.

Représentation JSON
{
  "description": string,
  "diskName": string,
  "diskSizeGb": string,
  "diskType": enum (DiskType),
  "labels": {
    string: string,
    ...
  }
}
Champs
description

string

Facultatif. Fournissez cette propriété lors de la création du disque.

diskName

string

Facultatif. Indique le nom du disque. Si aucune valeur n'est spécifiée, le nom de l'instance est utilisé par défaut. Si le disque portant le nom de l'instance existe déjà dans la zone ou la région concernée, un nouveau nom sera généré automatiquement.

diskSizeGb

string (int64 format)

Facultatif. Spécifie la taille du disque en Go (base 2). Si aucune taille n'est spécifiée, le disque aura la même taille que l'image (généralement 10 Go). Si elle est spécifiée, la taille doit être supérieure ou égale à 10 Go. 100 Go par défaut.

diskType

enum (DiskType)

Uniquement en entrée. Type de disque de démarrage associé à cette instance. La valeur par défaut est "Disque persistant standard" (PD_STANDARD).

labels

map (key: string, value: string)

Facultatif. Libellés à appliquer à ce disque. Vous pourrez les modifier ultérieurement à l'aide de la méthode disks.setLabels. Ce champ ne s'applique qu'aux disques persistants.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

DiskType

Types de disques possibles.

Enums
DISK_TYPE_UNSPECIFIED Le type de disque n'est pas défini.
PD_STANDARD Type de disque persistant standard.
PD_SSD Type de disque persistant SSD.
PD_BALANCED Type de disque persistant avec équilibrage.
PD_EXTREME Type de disque persistant extrême.

EncryptionConfig

Représente une configuration de clé de chiffrement personnalisée pouvant être appliquée à une ressource. Tous les disques de la machine virtuelle seront chiffrés.

Représentation JSON
{
  "kmsKey": string
}
Champs
kmsKey

string

Identifiant de ressource Cloud KMS de la clé de chiffrement gérée par le client qui est utilisée pour protéger une ressource, telle qu'un disque. Son format est le suivant : projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

RuntimeShieldedInstanceConfig

Ensemble d'options d'instances protégées. Consultez Images utilisant les fonctionnalités de VM protégées compatibles. Toutes les combinaisons ne sont pas valides.

Représentation JSON
{
  "enableSecureBoot": boolean,
  "enableVtpm": boolean,
  "enableIntegrityMonitoring": boolean
}
Champs
enableSecureBoot

boolean

Définit si le démarrage sécurisé est activé sur l'instance.

Le démarrage sécurisé vous permet de vous assurer que le système n'exécute que des logiciels authentiques. Il vérifie pour cela la signature numérique de tous les composants de démarrage et interrompt le processus de démarrage si cette vérification échoue. Désactivé par défaut

enableVtpm

boolean

Définit si le vTPM est activé pour l'instance. Cette option est activée par défaut.

enableIntegrityMonitoring

boolean

Définit si la surveillance de l'intégrité est activée pour l'instance.

Permet la surveillance et l'attestation de l'intégrité du démarrage de l'instance. L'attestation est effectuée par rapport à la règle d'intégrité de référence. Cette référence est initialement issue de l'image de démarrage implicitement approuvée lors de la création de l'instance. Cette option est activée par défaut.

RuntimeAcceleratorConfig

Définition des types d'accélérateurs matériels pouvant être utilisés. Consultez Compute Engine AcceleratorTypes. Exemples :

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
Représentation JSON
{
  "type": enum (AcceleratorType),
  "coreCount": string
}
Champs
type

enum (AcceleratorType)

Modèle d'accélérateur.

coreCount

string (int64 format)

Nombre de cœurs de cet accélérateur.

AcceleratorType

Type de cet accélérateur.

Enums
ACCELERATOR_TYPE_UNSPECIFIED Le type d'accélérateur n'est pas spécifié.
NVIDIA_TESLA_K80

Le type d'accélérateur est Nvidia Tesla K80.

NVIDIA_TESLA_P100 Le type d'accélérateur est Nvidia Tesla P100.
NVIDIA_TESLA_V100 Le type d'accélérateur est Nvidia Tesla V100.
NVIDIA_TESLA_P4 Le type d'accélérateur est Nvidia Tesla P4.
NVIDIA_TESLA_T4 Le type d'accélérateur est Nvidia Tesla T4.
NVIDIA_TESLA_A100 Le type d'accélérateur est Nvidia Tesla A100 – 40 Go.
NVIDIA_L4 Le type d'accélérateur est Nvidia L4.
TPU_V2 (Bientôt disponible) Le type d'accélérateur est TPU V2.
TPU_V3 (Bientôt disponible) Le type d'accélérateur est TPU v3.
NVIDIA_TESLA_T4_VWS Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla T4".
NVIDIA_TESLA_P100_VWS Le type d'accélérateur est NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS Le type d'accélérateur est NVIDIA Tesla P4 Virtual Workstations.

NicType

Type de pilote vNIC. La valeur par défaut doit être UNSPECIFIED_NIC_TYPE.

Enums
UNSPECIFIED_NIC_TYPE Aucun type spécifié.
VIRTIO_NET VIRTIO
GVNIC GVNIC

BootImage

Ce type ne comporte aucun champ.

Définition de l'image de démarrage utilisée par le Runtime. Utilisé pour faciliter la mise à niveau de l'environnement d'exécution.

État

Définition des états de ce runtime.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
STARTING La couche de calcul démarre le runtime. Il n'est pas prêt à être utilisé.
PROVISIONING La couche de calcul installe les frameworks requis et enregistre le runtime auprès du proxy du notebook. Il ne peut pas être utilisé.
ACTIVE Le runtime est en cours d'exécution. Il est prêt à l'emploi.
STOPPING La logique de contrôle arrête l'exécution. Il ne peut pas être utilisé.
STOPPED L'environnement d'exécution est arrêté. Il ne peut pas être utilisé.
DELETING L'environnement d'exécution est en cours de suppression. Il ne peut pas être utilisé.
UPGRADING La mise à niveau du runtime est en cours. Il ne peut pas être utilisé.
INITIALIZING L'environnement d'exécution est en cours de création et de configuration. Il n'est pas prêt à être utilisé.

HealthState

Sous-état de l'exécution.

Enums
HEALTH_STATE_UNSPECIFIED Le sous-état d'exécution est inconnu.
HEALTHY L'environnement d'exécution est connu pour être en bon état (par exemple, les daemons critiques sont en cours d'exécution). S'applique à l'état ACTIVE.
UNHEALTHY L'état du runtime est connu comme étant défectueux (par exemple, les daemons critiques ne sont pas en cours d'exécution). S'applique à l'état ACTIVE.
AGENT_NOT_INSTALLED L'environnement d'exécution n'a pas installé l'agent de surveillance de l'état. S'applique à l'état ACTIF.
AGENT_NOT_RUNNING L'agent de surveillance de l'état de l'exécution n'est pas en cours d'exécution. S'applique à l'état ACTIF.

RuntimeAccessConfig

Spécifie la configuration de connexion pour l'environnement d'exécution.

Représentation JSON
{
  "accessType": enum (RuntimeAccessType),
  "runtimeOwner": string,
  "proxyUri": string
}
Champs
accessType

enum (RuntimeAccessType)

Type de mode d'accès de cette instance.

runtimeOwner

string

Propriétaire de ce runtime après sa création. Format : alias@example.com. Pour le moment, un seul propriétaire est accepté.

proxyUri

string

Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au runtime.

RuntimeAccessType

Différentes façons d'accéder au runtime. Mode d'authentification. Actuellement, seul l'utilisateur unique est accepté.

Enums
RUNTIME_ACCESS_TYPE_UNSPECIFIED Accès non spécifié.
SINGLE_USER Connexion d'un seul utilisateur.
SERVICE_ACCOUNT Mode Compte de service. En mode "Compte de service", le créateur de l'environnement d'exécution spécifie un compte de service existant dans le projet client. Utiliser le champ "Compte de service d'exécution". Les utilisateurs qui accèdent à l'environnement d'exécution doivent disposer de l'autorisation "Agir en tant que" (utilisateur du compte de service).

RuntimeSoftwareConfig

Spécifie la sélection et la configuration des logiciels dans l'environnement d'exécution. Propriétés à définir lors de l'exécution. Les clés de propriétés sont spécifiées au format key:value, par exemple :

  • idleShutdown: true
  • idleShutdownTimeout: 180
  • enableHealthMonitoring: true
Représentation JSON
{
  "notebookUpgradeSchedule": string,
  "idleShutdownTimeout": integer,
  "installGpuDriver": boolean,
  "customGpuDriverPath": string,
  "postStartupScript": string,
  "kernels": [
    {
      object (ContainerImage)
    }
  ],
  "postStartupScriptBehavior": enum (PostStartupScriptBehavior),
  "enableHealthMonitoring": boolean,
  "idleShutdown": boolean,
  "upgradeable": boolean,
  "disableTerminal": boolean,
  "version": string,
  "mixerDisabled": boolean
}
Champs
notebookUpgradeSchedule

string

Expression Cron dans le fuseau horaire UTC, utilisée pour planifier la mise à niveau automatique de l'instance. Veuillez respecter le format Cron.

idleShutdownTimeout

integer

Temps en minutes à attendre avant d'arrêter l'environnement d'exécution. Par défaut : 180 minutes

installGpuDriver

boolean

Installez automatiquement le pilote Nvidia. Valeur par défaut : True

customGpuDriverPath

string

Spécifiez un chemin d'accès Cloud Storage personnalisé où le pilote GPU est stocké. Si vous n'en indiquez pas, nous choisirons automatiquement parmi les pilotes de GPU officiels.

postStartupScript

string

Chemin d'accès à un script Bash qui s'exécute automatiquement après le démarrage complet d'une instance de notebook. Le chemin d'accès doit être une URL ou un chemin d'accès Cloud Storage (gs://path-to-file/file-name).

kernels[]

object (ContainerImage)

Facultatif. Utilisez une liste d'images de conteneurs à utiliser comme noyaux dans l'instance de notebook.

postStartupScriptBehavior

enum (PostStartupScriptBehavior)

Comportement du script post-démarrage.

enableHealthMonitoring

boolean

Vérifiez que les services internes principaux sont en cours d'exécution. Valeur par défaut : True

idleShutdown

boolean

L'environnement d'exécution s'arrêtera automatiquement après idle_shutdown_time. Valeur par défaut : True

upgradeable

boolean

Uniquement en sortie. Booléen indiquant si une image plus récente est disponible dans une famille d'images.

disableTerminal

boolean

Booléen indiquant si le terminal JupyterLab sera disponible ou non. Valeur par défaut : False

version

string

Sortie uniquement. Version de l'image de démarrage, telle que M100, à partir du libellé de version de l'image.

mixerDisabled

boolean

Booléen indiquant si le client Mixer doit être désactivé. Valeur par défaut : False

PostStartupScriptBehavior

Comportement du script post-démarrage.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED Comportement du script post-démarrage non spécifié. S'exécutera une seule fois lors de la création.
RUN_EVERY_START Exécute le script de post-démarrage fourni lors de la création à chaque démarrage.
DOWNLOAD_AND_RUN_EVERY_START Télécharge et exécute le script de post-démarrage fourni à chaque démarrage.

RuntimeMetrics

Contient les métriques du démon d'exécution, telles que les statistiques sur l'OS, les noyaux et les sessions.

Représentation JSON
{
  "systemMetrics": {
    string: string,
    ...
  }
}
Champs
systemMetrics

map (key: string, value: string)

Uniquement en sortie. Métriques système.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RuntimeMigrationEligibility

RuntimeMigrationEligibility représente les informations sur la faisabilité d'une migration de GmN vers WbI.

Représentation JSON
{
  "warnings": [
    enum (Warning)
  ],
  "errors": [
    enum (Error)
  ]
}
Champs
warnings[]

enum (Warning)

Uniquement en sortie. Certaines configurations seront définies par défaut lors de la migration.

errors[]

enum (Error)

Uniquement en sortie. Certaines configurations rendent le GmN inéligible à une migration automatique. Une migration manuelle est requise.

Avertissement

Un message d'avertissement concernant la migration signifie que certaines configurations seront définies par défaut pendant la migration.

Enums
WARNING_UNSPECIFIED Type par défaut.
UNSUPPORTED_ACCELERATOR_TYPE Le notebook GmN utilise un type d'accélérateur non compatible avec WbI. Il sera migré sans accélérateur. Les utilisateurs peuvent associer un accélérateur après la migration.
UNSUPPORTED_OS Le GmN utilise un système d'exploitation non compatible avec WbI (par exemple, Debian 10). Il sera remplacé par Debian 11 dans WbI.
RESERVED_IP_RANGE Ce GmN est configuré avec une plage d'adresses IP réservée, qui n'est plus applicable dans WbI.
GOOGLE_MANAGED_NETWORK Ce GmN est configuré avec un réseau géré par Google. Veuillez indiquer les options network et subnet pour la migration.
POST_STARTUP_SCRIPT Ce GmN est configuré avec un script post-démarrage. Veuillez éventuellement fournir le postStartupScriptOption pour la migration.
SINGLE_USER Ce GmN est configuré en mode utilisateur unique. Veuillez éventuellement fournir l'option serviceAccount pour la migration.

Erreur

Un message d'erreur de migration signifie que certaines configurations rendent le GmN inéligible à une migration automatique. Une migration manuelle est requise.

Enums
ERROR_UNSPECIFIED Type par défaut.
CUSTOM_CONTAINER Le GmN est configuré avec un ou plusieurs conteneurs personnalisés et ne peut pas être migré.

Méthodes

create

Crée un Runtime dans un projet et un emplacement donnés.

delete

Supprime un seul Runtime.

get

Récupère les détails d'un seul environnement d'exécution.

getIamPolicy

Récupère la stratégie de contrôle d'accès d'une ressource.

list

Liste les runtimes d'un projet et d'un emplacement donnés.

migrate

Migrer un environnement d'exécution existant vers une nouvelle instance Workbench

patch

Mettez à jour la configuration de l'environnement d'exécution du notebook.

reportEvent

Signale et traite un événement d'exécution.

reset

Réinitialise un environnement d'exécution de notebook géré.

setIamPolicy

Définit la stratégie de contrôle d'accès de la ressource spécifiée.

start

Démarre un environnement d'exécution de notebooks gérés.

stop

Arrête un environnement d'exécution de notebook géré.

switch

Changer d'environnement d'exécution d'un notebook géré

testIamPermissions

Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.