Ressource : Instance
Définition d'une instance de notebook.
| Représentation JSON |
|---|
{ "name": string, "proxyUri": string, "instanceOwners": [ string ], "creator": string, "state": enum ( |
| Champs | |
|---|---|
name |
Uniquement en sortie. Identifiant. Nom de cette instance de notebook. Format : |
proxyUri |
Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au notebook Jupyter. |
instanceOwners[] |
Facultatif. Propriétaire de cette instance après sa création. Format : Actuellement, un seul propriétaire est accepté. Si aucun utilisateur n'est spécifié, tous les utilisateurs du compte de service de votre instance de VM peuvent utiliser l'instance. |
creator |
Uniquement en sortie. Adresse e-mail de l'entité ayant envoyé la requête instances.create initiale. |
state |
Uniquement en sortie. État de cette instance. |
upgradeHistory[] |
Uniquement en sortie. Historique des mises à niveau de cette instance. |
id |
Uniquement en sortie. ID unique de la ressource. |
healthState |
Uniquement en sortie. État de fonctionnement de l'instance. |
healthInfo |
Uniquement en sortie. Informations supplémentaires sur l'état de l'instance. Exemple : Objet contenant une liste de paires |
createTime |
Uniquement en sortie. Heure de création de l'instance. 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 : |
updateTime |
Uniquement en sortie. Heure de mise à jour de l'instance. 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 : |
disableProxyAccess |
Facultatif. Si la valeur est "true", l'instance de notebook ne s'enregistre pas auprès du proxy. |
labels |
Facultatif. Libellés à appliquer à cette instance. Vous pourrez les modifier ultérieurement à l'aide de la méthode instances.patch. Objet contenant une liste de paires |
thirdPartyProxyUrl |
Uniquement en sortie. Point de terminaison proxy des pools de personnel utilisé pour accéder au notebook Jupyter. |
satisfiesPzs |
Uniquement en sortie. Réservé pour une utilisation ultérieure pour la séparation des zones. |
satisfiesPzi |
Uniquement en sortie. Réservé pour une utilisation ultérieure pour l'isolation des zones. |
enableThirdPartyIdentity |
Facultatif. Indicateur qui précise qu'un notebook est accessible avec un fournisseur d'identité tiers. |
enableManagedEuc |
Facultatif. Indicateur permettant d'activer les identifiants gérés de l'utilisateur final pour l'instance. |
enableDeletionProtection |
Facultatif. Si la valeur est "true", la protection contre la suppression sera activée pour cette instance Workbench. Si la valeur est "false", la protection contre la suppression sera désactivée pour cette instance Workbench. |
| Configuration de l'instance de notebook. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse : | |
gceSetup |
Facultatif. Configuration de Compute Engine pour le notebook. Utilise les champs définis dans le notebook. |
| Fin des champs qui s'excluent mutuellement. | |
GceSetup
Définition de la configuration d'une instance de VM en dehors des ressources et de l'identité.
| Représentation JSON |
|---|
{ "machineType": string, "minCpuPlatform": string, "acceleratorConfigs": [ { object ( |
| Champs | |
|---|---|
machineType |
Facultatif. Type de machine de l'instance de VM. https://cloud.google.com/compute/docs/machine-resource |
minCpuPlatform |
Facultatif. Configuration minimale de la plate-forme de processeur à utiliser pour cette instance. La liste des valeurs valides est disponible sur https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones. |
acceleratorConfigs[] |
Facultatif. Accélérateurs matériels utilisés sur cette instance. Si vous utilisez des accélérateurs, assurez-vous que votre configuration dispose de suffisamment de processeurs virtuels et de mémoire pour prendre en charge les |
serviceAccounts[] |
Facultatif. Compte de service qui sert d'identité à l'instance de VM. Actuellement, un seul compte de service est accepté. |
bootDisk |
Facultatif. Disque de démarrage de la VM. |
dataDisks[] |
Facultatif. Disques de données associés à l'instance de VM. Actuellement, un seul disque de données est accepté. |
shieldedInstanceConfig |
Facultatif. Configuration de VM protégée. Images utilisant les fonctionnalités de VM protégée compatibles |
networkInterfaces[] |
Facultatif. Interfaces réseau de la VM. Ne prend en charge qu'une seule interface. |
disablePublicIp |
Facultatif. Si la valeur est "true", aucune adresse IP externe ne sera attribuée à cette instance de VM. |
tags[] |
Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau). |
metadata |
Facultatif. Métadonnées personnalisées à appliquer à cette instance. Objet contenant une liste de paires |
systemMetadata |
Uniquement en sortie. Représente les métadonnées gérées par le système pour cette instance : le sous-ensemble de Objet contenant une liste de paires |
enableIpForwarding |
Facultatif. Indicateur permettant d'activer ou non le transfert d'adresse IP. La valeur par défaut est "false" (désactivé). https://cloud.google.com/vpc/docs/using-routes#canipforward |
gpuDriverConfig |
Facultatif. Configuration des pilotes de GPU. |
confidentialInstanceConfig |
Facultatif. Configuration d'instance confidentielle. |
instanceId |
Uniquement en sortie. ID unique de la ressource d'instance Compute Engine. |
| Type de l'image : image de VM ou image de conteneur. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse : | |
vmImage |
Facultatif. Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook. |
containerImage |
Facultatif. Utilisez une image de conteneur pour démarrer l'instance de notebook. |
| Fin des champs qui s'excluent mutuellement. | |
AcceleratorConfig
Configuration d'un accélérateur pour une instance de VM Définition d'un accélérateur matériel. Notez qu'il n'y a pas de vérification des combinaisons type et coreCount. Les TPU ne sont pas compatibles. Pour trouver une combinaison valide, consultez GPU sur Compute Engine.
| Représentation JSON |
|---|
{
"type": enum ( |
| Champs | |
|---|---|
type |
Facultatif. Type de cet accélérateur. |
coreCount |
Facultatif. Nombre de cœurs de cet accélérateur. |
AcceleratorType
Définition des types d'accélérateurs matériels pouvant être utilisés sur cette instance.
| Enums | |
|---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
Le type d'accélérateur n'est pas spécifié. |
NVIDIA_TESLA_P100 |
Obsolète : utilisez |
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_A100_80GB |
Le type d'accélérateur est Nvidia Tesla A100-80GB. |
NVIDIA_L4 |
Le type d'accélérateur est Nvidia Tesla L4. |
NVIDIA_H100_80GB |
Le type d'accélérateur est Nvidia Tesla H100 – 80 Go. |
NVIDIA_H100_MEGA_80GB |
Le type d'accélérateur est Nvidia Tesla H100 – MEGA 80 Go. |
NVIDIA_H200_141GB |
Le type d'accélérateur est Nvidia Tesla H200 – 141 Go. |
NVIDIA_TESLA_T4_VWS |
Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla T4". |
NVIDIA_TESLA_P100_VWS |
Obsolète : utilisez plutôt |
NVIDIA_TESLA_P4_VWS |
Le type d'accélérateur est NVIDIA Tesla P4 Virtual Workstations. |
NVIDIA_B200 |
Le type d'accélérateur est NVIDIA B200. |
NVIDIA_RTX6000 |
NVIDIA RTX 6000. |
ServiceAccount
Un compte de service qui sert d'identité.
| Représentation JSON |
|---|
{ "email": string, "scopes": [ string ] } |
| Champs | |
|---|---|
email |
Facultatif. Adresse e-mail du compte de service. |
scopes[] |
Uniquement en sortie. Liste des champs d'application à rendre disponibles pour ce compte de service. Défini par le CLH sur https://www.googleapis.com/auth/cloud-platform |
VmImage
Définition d'une image de machine virtuelle Compute Engine personnalisée pour démarrer une instance de notebook avec l'environnement installé directement sur la VM.
| Représentation 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. } |
| Champs | |
|---|---|
project |
Obligatoire. Nom du projet Google Cloud auquel appartient cette image de VM. Format : |
imageDescription |
Uniquement en sortie. Description lisible par l'humain de l'image exécutée sur l'instance (par exemple, "Debian 11, Python 3.10"), dérivée au moment de la lecture à partir de la configuration de la version de l'image (la source de vérité). Définissez la valeur sur "Personnalisé" pour les images de disque de démarrage non reconnues. |
| Référence à une image de VM Compute Engine externe. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse : | |
name |
Facultatif. Utilisez le nom de l'image de VM pour la trouver. |
family |
Facultatif. Utilisez cette famille d'images de VM pour trouver l'image. L'image la plus récente de cette famille sera utilisée. |
| Fin des champs qui s'excluent mutuellement. | |
ContainerImage
Définition d'une image de conteneur pour démarrer une instance de notebook avec l'environnement installé dans un conteneur.
| Représentation JSON |
|---|
{ "repository": string, "tag": string } |
| Champs | |
|---|---|
repository |
Obligatoire. Chemin d'accès au dépôt d'images de conteneurs. Par exemple : |
tag |
Facultatif. Tag de l'image de conteneur. Si aucune valeur n'est spécifiée, la valeur par défaut est le tag le plus récent. |
BootDisk
Définition d'un disque de démarrage.
| Représentation JSON |
|---|
{ "diskSizeGb": string, "diskType": enum ( |
| Champs | |
|---|---|
diskSizeGb |
Facultatif. Taille du disque de démarrage en Go associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). Si aucune valeur n'est spécifiée, la valeur par défaut est la valeur recommandée de 150 Go. |
diskType |
Facultatif. Indique le type de disque. |
diskEncryption |
Facultatif. Méthode de chiffrement de disque utilisée sur les disques de démarrage et de données. La valeur par défaut est GMEK. |
kmsKey |
Facultatif. Clé KMS utilisée pour chiffrer les disques. Ne s'applique que si diskEncryption est défini sur CMEK. Format : En savoir plus sur l'utilisation de vos propres clés de chiffrement |
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. |
HYPERDISK_BALANCED |
Représente le type de disque persistant Hyperdisk Balanced. Peut être utilisé comme disque de démarrage ou disque de données. |
HYPERDISK_EXTREME |
Représente le type de disque persistant Hyperdisk Extreme. Ne peut être utilisé que comme disque de données. |
HYPERDISK_THROUGHPUT |
Représente le type de disque persistant Hyperdisk Throughput. Ne peut être utilisé que comme disque de données. |
HYPERDISK_BALANCED_HIGH_AVAILABILITY |
Représente le type de disque persistant Hyperdisk Balanced High Availability. Peut être utilisé comme disque de démarrage ou disque de données. |
HYPERDISK_ML |
Représente le type de disque persistant Hyperdisk ML. Peut être utilisé comme disque de démarrage ou disque de données. |
DiskEncryption
Définition des options de chiffrement du disque.
| Enums | |
|---|---|
DISK_ENCRYPTION_UNSPECIFIED |
Le chiffrement de disque n'est pas spécifié. |
GMEK |
Utilisez des clés de chiffrement gérées par Google pour chiffrer le disque de démarrage. |
CMEK |
Utilisez des clés de chiffrement gérées par le client pour chiffrer le disque de démarrage. |
DataDisk
Ressource de disque associée à une instance.
| Représentation JSON |
|---|
{ "diskSizeGb": string, "diskType": enum ( |
| Champs | |
|---|---|
diskSizeGb |
Facultatif. Taille du disque en Go associé à cette instance de VM, jusqu'à un maximum de 64 000 Go (64 To). Si aucune valeur n'est spécifiée, la valeur par défaut est 100. |
diskType |
Facultatif. Indique le type de disque. |
diskEncryption |
Facultatif. Méthode de chiffrement de disque utilisée sur les disques de démarrage et de données. La valeur par défaut est GMEK. |
kmsKey |
Facultatif. Clé KMS utilisée pour chiffrer les disques. Ne s'applique que si diskEncryption est défini sur CMEK. Format : En savoir plus sur l'utilisation de vos propres clés de chiffrement |
resourcePolicies[] |
Facultatif. Stratégies de ressources à appliquer au disque de données. |
ShieldedInstanceConfig
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 |
Facultatif. Définit si le démarrage sécurisé est activé pour l'instance de VM. 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 |
Facultatif. Définit si le module vTPM est activé pour l'instance de VM. |
enableIntegrityMonitoring |
Facultatif. Définit si la surveillance de l'intégrité est activée pour l'instance de VM. Permet de surveiller et d'attester de l'intégrité du démarrage de l'instance de VM. 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 de VM. |
NetworkInterface
Définition d'une ressource d'interface réseau associée à une VM.
| Représentation JSON |
|---|
{ "network": string, "subnet": string, "nicType": enum ( |
| Champs | |
|---|---|
network |
Facultatif. Nom du VPC dans lequel se trouve cette instance de VM. Format : |
subnet |
Facultatif. Nom du sous-réseau dans lequel se trouve cette instance de VM. Format : |
nicType |
Facultatif. Type de carte d'interface réseau virtuelle à utiliser sur cette interface. Il peut s'agir de gVNIC ou de VirtioNet. |
accessConfigs[] |
Facultatif. Tableau de configurations pour cette interface. Actuellement, une seule configuration d'accès est acceptée : ONE_TO_ONE_NAT. Si aucune accessConfigs n'est spécifiée, l'instance disposera d'un accès externe à Internet via une adresse IP externe éphémère. |
internalIp |
Facultatif. Adresse IP interne associée à cette instance. Spécifiez une adresse IP interne statique inutilisée disponible pour le sous-réseau dans lequel se trouve cette instance, ou laissez ce champ non défini pour utiliser une adresse IP de la plage éphémère du sous-réseau. |
NicType
Type de pilote vNIC. La valeur par défaut doit être NIC_TYPE_UNSPECIFIED.
| Enums | |
|---|---|
NIC_TYPE_UNSPECIFIED |
Aucun type spécifié. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
AccessConfig
Configuration d'accès associée à l'interface réseau d'une instance.
| Représentation JSON |
|---|
{ "externalIp": string } |
| Champs | |
|---|---|
externalIp |
Facultatif. Adresse IP externe associée à cette instance. Spécifiez une adresse IP externe statique inutilisée disponible pour le projet ou laissez ce champ non défini pour utiliser une adresse IP d'un pool d'adresses IP éphémères partagé. Si vous spécifiez une adresse IP externe statique, elle doit se trouver dans la même région que la zone de l'instance. |
GPUDriverConfig
Configuration d'un pilote de GPU
| Représentation JSON |
|---|
{ "enableGpuDriver": boolean, "customGpuDriverPath": string } |
| Champs | |
|---|---|
enableGpuDriver |
Facultatif. Indique si l'utilisateur final autorise Google Cloud à installer le pilote de GPU sur cette instance de VM. Si ce champ est vide ou défini sur "false", le pilote de GPU ne sera pas installé. Ne s'applique qu'aux instances avec GPU. |
customGpuDriverPath |
Facultatif. 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. |
ConfidentialInstanceConfig
Ensemble d'options d'instance confidentielle.
| Représentation JSON |
|---|
{
"confidentialInstanceType": enum ( |
| Champs | |
|---|---|
confidentialInstanceType |
Facultatif. Définit le type de technologie utilisé par l'instance confidentielle. |
ConfidentialInstanceType
Type d'instance confidentielle.
| Enums | |
|---|---|
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED |
Aucun type spécifié. N'utilisez pas cette valeur. |
SEV |
AMD SEV (Secure Encrypted Virtualization) |
État
Définition des états de cette instance.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
L'état n'est pas spécifié. |
STARTING |
La logique de contrôle démarre l'instance. |
PROVISIONING |
La logique de contrôle installe les frameworks requis et enregistre l'instance auprès du proxy de notebook. |
ACTIVE |
L'instance est en cours d'exécution. |
STOPPING |
La logique de contrôle arrête l'instance. |
STOPPED |
L'instance est arrêtée. |
DELETED |
L'instance est supprimée. |
UPGRADING |
L'instance est en cours de mise à niveau. |
INITIALIZING |
L'instance est en cours de création. |
SUSPENDING |
L'instance est en cours de suspension. |
SUSPENDED |
L'instance est suspendue. |
ORPHANED |
L'instance ne comporte aucune VM. Une mise à niveau a supprimé le disque d'origine et n'a pas pu le remplacer. Le disque de données et les éventuels instantanés sont intacts. Réessayez de la mettre à niveau pour la terminer ou effectuez un rollback de l'instance vers l'instantané pris avant le début de la mise à niveau. |
UpgradeHistoryEntry
Entrée de l'historique de mise à niveau des images de VM.
| Représentation JSON |
|---|
{ "snapshot": string, "vmImage": string, "containerImage": string, "framework": string, "version": string, "state": enum ( |
| Champs | |
|---|---|
snapshot |
Facultatif. Instantané du disque de démarrage de cette instance de notebook avant la mise à niveau. |
vmImage |
Facultatif. Image de VM avant la mise à niveau de cette instance. |
containerImage |
Facultatif. Image de conteneur avant la mise à niveau de cette instance. |
framework |
Facultatif. Framework de cette instance de notebook. |
version |
Facultatif. Version de l'instance de notebook avant cette mise à niveau. |
state |
Uniquement en sortie. État de cette entrée de l'historique des mises à niveau de l'instance. |
createTime |
Immuable. Heure de création de cette entrée de l'historique des mises à niveau de l'instance. 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 : |
action |
Facultatif. Action. Effectuez un rollback ou une mise à niveau. |
targetVersion |
Facultatif. Version de la VM cible, comme m63. |
État
Définition des états de cette entrée de l'historique des mises à niveau.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
L'état n'est pas spécifié. |
STARTED |
La mise à niveau de l'instance a commencé. |
SUCCEEDED |
La mise à niveau de l'instance a réussi. |
FAILED |
Échec de la mise à niveau de l'instance. |
Action
Définition des opérations de cette entrée de l'historique des mises à niveau.
| Enums | |
|---|---|
ACTION_UNSPECIFIED |
L'opération n'est pas spécifiée. |
UPGRADE |
Passez à l'édition supérieure. |
ROLLBACK |
Rollback. |
HealthState
État de fonctionnement de l'instance.
| Enums | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
Le sous-état de l'instance est inconnu. |
HEALTHY |
L'instance est connue pour être dans un état sain (par exemple, les daemons critiques sont en cours d'exécution). S'applique à l'état "ACTIVE". |
UNHEALTHY |
L'instance est connue pour être dans un état non sain (par exemple, les daemons critiques ne sont pas en cours d'exécution). S'applique à l'état ACTIVE. |
AGENT_NOT_INSTALLED |
L'agent de surveillance de l'état n'est pas installé sur l'instance. S'applique à l'état ACTIF. |
AGENT_NOT_RUNNING |
L'agent de surveillance de l'état de l'instance n'est pas en cours d'exécution. S'applique à l'état ACTIF. |
Méthodes |
|
|---|---|
|
Vérifie si une instance de notebook peut être mise à niveau. |
|
Créer une instance dans un projet et un emplacement donnés. |
|
Supprimer une seule instance. |
|
Crée un fichier de diagnostic et exécute l'outil de diagnostic pour une instance donnée. |
|
Récupère les informations concernant une seule instance. |
|
Renvoie différents paramètres de configuration. |
|
Récupère la stratégie de contrôle d'accès d'une ressource. |
|
Liste les instances d'un projet et d'un emplacement donnés. |
|
UpdateInstance met à jour une instance. |
|
Réinitialise une instance de notebook. |
|
Redimensionnez le disque d'une instance de notebook pour augmenter sa capacité. |
|
RestoreInstance restaure une instance à partir d'une BackupSource. |
|
Effectue un rollback d'une instance de notebook vers la version précédente. |
|
Définit la stratégie de contrôle d'accès de la ressource spécifiée. |
|
Démarre une instance de notebook. |
|
Arrête une instance de notebook. |
|
Renvoie les autorisations qu'un appelant a sur la ressource spécifiée. |
|
Met à niveau une instance de notebook vers la dernière version. |