Ressource : Instance
Définition d'une instance de notebook.
| Représentation JSON |
|---|
{ "name": string, "postStartupScript": string, "proxyUri": string, "instanceOwners": [ string ], "serviceAccount": string, "serviceAccountScopes": [ string ], "machineType": string, "acceleratorConfig": { object ( |
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom de cette instance de notebook. Format : |
postStartupScript |
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 ( |
proxyUri |
Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au notebook Jupyter. |
instanceOwners[] |
Uniquement en entrée. 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. |
serviceAccount |
Le compte de service de cette instance, qui donne accès à d'autres services Google Cloud. Vous pouvez utiliser n'importe quel compte de service au sein du même projet, mais vous devez disposer de l'autorisation "Utilisateur du compte de service" pour utiliser l'instance. Si aucune valeur n'est spécifiée, le compte de service Compute Engine par défaut est utilisé. |
serviceAccountScopes[] |
Facultatif. URI des niveaux d'accès des comptes de service à inclure dans les instances Compute Engine. Si aucun n'est spécifié, les niveaux d'accès suivants sont définis : - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Si vous n'utilisez pas les niveaux d'accès par défaut, vous devez au moins utiliser : https://www.googleapis.com/auth/compute |
machineType |
Obligatoire. Le type de machine Compute Engine de cette instance. |
acceleratorConfig |
Accélérateur matériel utilisé 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 |
state |
Uniquement en sortie. État de cette instance. |
installGpuDriver |
Indique si l'utilisateur final autorise Google Cloud à installer le pilote de GPU sur cette instance. 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 |
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. |
bootDiskType |
Uniquement en entrée. Type de disque de démarrage associé à cette instance. La valeur par défaut est "Disque persistant standard" ( |
bootDiskSizeGb |
Uniquement en entrée. Taille du disque de démarrage en Go associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). La valeur minimale recommandée est de 100 Go. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. |
dataDiskType |
Uniquement en entrée. Type de disque de données associé à cette instance. La valeur par défaut est "disque persistant standard" ( |
dataDiskSizeGb |
Uniquement en entrée. Taille du disque de données en Go associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). Vous pouvez choisir la taille du disque de données en fonction de la taille de vos notebooks et de vos données. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. |
noRemoveDataDisk |
Uniquement en entrée. Si la valeur est "true", le disque de données ne sera pas supprimé automatiquement lors de la suppression de l'instance. |
diskEncryption |
Uniquement en entrée. 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 |
Uniquement en entrée. 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 |
disks[] |
Uniquement en sortie. Disques associés à l'instance de notebook. |
shieldedInstanceConfig |
Facultatif. Configuration de VM protégée. Images utilisant les fonctionnalités de VM protégée compatibles |
noPublicIp |
Si la valeur est "true", aucune adresse IP externe ne sera attribuée à cette instance. |
noProxyAccess |
Si la valeur est "true", l'instance de notebook ne s'enregistre pas auprès du proxy. |
network |
Nom du VPC dans lequel se trouve cette instance. Format : |
subnet |
Nom du sous-réseau dans lequel se trouve cette instance. Format : |
labels |
Libellés à appliquer à cette instance. Vous pourrez les modifier ultérieurement à l'aide de la méthode setLabels. Objet contenant une liste de paires |
metadata |
Métadonnées personnalisées à appliquer à cette instance. Par exemple, pour spécifier un bucket Cloud Storage pour la sauvegarde automatique, vous pouvez utiliser le tag de métadonnées Objet contenant une liste de paires |
tags[] |
Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau). |
upgradeHistory[] |
Historique des mises à niveau de cette instance. |
nicType |
Facultatif. Type de carte d'interface réseau virtuelle à utiliser sur cette interface. Il peut s'agir de gVNIC ou de VirtioNet. |
reservationAffinity |
Facultatif. Affinité de réservation facultative. Si vous définissez ce champ, la réservation de calcul zonal spécifiée sera appliquée à cette instance de notebook. |
creator |
Uniquement en sortie. Adresse e-mail de l'entité ayant envoyé la requête instances.create initiale. |
canIpForward |
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 |
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 : |
instanceMigrationEligibility |
Uniquement en sortie. Vérifie la faisabilité d'une migration d'UmN vers WbI. |
| Type d'environnement : 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 |
Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook. |
containerImage |
Utilisez une image de conteneur pour démarrer l'instance de notebook. |
| Fin des champs qui s'excluent mutuellement. | |
migrated |
Uniquement en sortie. Booléen indiquant si ce notebook a été migré vers une instance Workbench |
AcceleratorConfig
Définition d'un accélérateur matériel. Notez que toutes les combinaisons de type et coreCount ne sont pas valides. Pour trouver une combinaison valide, consultez GPU sur Compute Engine. Les TPU ne sont pas compatibles.
| Représentation JSON |
|---|
{
"type": enum ( |
| Champs | |
|---|---|
type |
Type de cet accélérateur. |
coreCount |
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_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. |
NVIDIA_L4 |
Le type d'accélérateur est Nvidia Tesla L4. |
NVIDIA_A100_80GB |
Le type d'accélérateur est Nvidia Tesla A100 80 Go. |
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. |
NVIDIA_H100_80GB |
Le type d'accélérateur est NVIDIA H100 80 Go. |
NVIDIA_H100_MEGA_80GB |
Le type d'accélérateur est NVIDIA H100 Mega 80 Go. |
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. |
É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. |
REGISTERING |
L'instance est en cours d'enregistrement. |
SUSPENDING |
L'instance est en cours de suspension. |
SUSPENDED |
L'instance est suspendue. |
DiskType
Types de disques possibles pour les instances de notebooks.
| 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. |
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. |
Disque
Ressource de disque associée à une instance.
| Représentation JSON |
|---|
{
"autoDelete": boolean,
"boot": boolean,
"deviceName": string,
"diskSizeGb": string,
"guestOsFeatures": [
{
object ( |
| Champs | |
|---|---|
autoDelete |
Indique si le disque sera automatiquement supprimé lorsque l'instance sera supprimée (mais pas lorsque le disque sera dissocié de l'instance). |
boot |
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 |
Indique un nom d'appareil unique de votre choix qui est reflété dans l'arborescence 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. |
diskSizeGb |
Indique la taille du disque en Go (base 2). |
guestOsFeatures[] |
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 |
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. |
interface |
Indique 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 :
|
kind |
Type de la ressource. Calculez toujours compute#attachedDisk pour les disques associés. |
licenses[] |
Liste des licences visibles publiquement. Réservé à l'usage de Google. Une licence représente les données de facturation et d'utilisation agrégées pour les images publiques et celles de la place de marché. |
mode |
Mode d'association de ce disque,
|
source |
Indique une URL partielle ou complète valide vers une ressource de disque persistant existante. |
type |
Indique le type de disque :
|
GuestOsFeature
Fonctionnalités de l'OS invité pour le disque de démarrage.
| Représentation JSON |
|---|
{ "type": string } |
| Champs | |
|---|---|
type |
ID d'une fonctionnalité compatible. Consultez la section "Activer des fonctionnalités d'un système d'exploitation invité" pour obtenir la liste des options disponibles. Valeurs correctes :
|
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 |
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 |
Définit si le vTPM est activé pour l'instance. Cette option est activée par défaut. |
enableIntegrityMonitoring |
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. |
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 |
Instantané du disque de démarrage de cette instance de notebook avant la mise à niveau. |
vmImage |
Image de VM avant la mise à niveau de cette instance. |
containerImage |
Image de conteneur avant la mise à niveau de cette instance. |
framework |
Framework de cette instance de notebook. |
version |
Version de l'instance de notebook avant cette mise à niveau. |
state |
État de cette entrée de l'historique des mises à niveau de l'instance. |
createTime |
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 : |
targetImage |
Image de VM cible. Format : |
action |
Action. Effectuez un rollback ou une mise à niveau. |
targetVersion |
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. |
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 |
ReservationAffinity
Affinité de réservation pour la consommation de la réservation zonale.
| Représentation JSON |
|---|
{
"consumeReservationType": enum ( |
| Champs | |
|---|---|
consumeReservationType |
Facultatif. Type de réservation à utiliser |
key |
Facultatif. Correspond à la clé d'étiquette de la ressource de réservation. |
values[] |
Facultatif. Correspond aux valeurs d'étiquette de la ressource de réservation. |
Type
Indique s'il faut consommer de la capacité à partir d'une réservation ou non.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Type par défaut. |
NO_RESERVATION |
Ne pas consommer de capacité allouée. |
ANY_RESERVATION |
Utiliser toute réservation disponible. |
SPECIFIC_RESERVATION |
Doit utiliser une réservation spécifique. Vous devez spécifier les champs de clé-valeur pour indiquer les réservations. |
InstanceMigrationEligibility
InstanceMigrationEligibility représente les informations sur la faisabilité d'une migration d'UmN vers WbI.
| Représentation JSON |
|---|
{ "warnings": [ enum ( |
| Champs | |
|---|---|
warnings[] |
Uniquement en sortie. Certaines configurations seront définies par défaut lors de la migration. |
errors[] |
Uniquement en sortie. Certaines configurations rendent l'UmN inéligible à la 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_MACHINE_TYPE |
L'UmN utilise un type de machine non compatible avec WbI. Il sera migré avec le type de machine e2-standard-4 par défaut. Les utilisateurs peuvent modifier le type de machine après la migration. |
UNSUPPORTED_ACCELERATOR_TYPE |
L'UmN utilise un type d'accélérateur non compatible avec WbI. Il sera migré sans accélérateur. L'utilisateur peut associer un accélérateur après la migration. |
UNSUPPORTED_OS |
L'UmN utilise un système d'exploitation non compatible avec WbI (par exemple, Debian 10 ou Ubuntu). Il sera remplacé par Debian 11 dans WbI. |
NO_REMOVE_DATA_DISK |
Ce notebook est configuré avec noRemoveDataDisk, qui n'est plus disponible dans WbI. |
GCS_BACKUP |
Ce notebook est configuré avec la fonctionnalité de sauvegarde Cloud Storage, qui n'est plus disponible dans les instances Workbench. |
POST_STARTUP_SCRIPT |
Cette UMN est configurée avec un script post-démarrage. Veuillez éventuellement fournir le postStartupScriptOption pour la migration. |
Erreur
Un message d'erreur de migration signifie que certaines configurations rendent l'UMn non éligible à une migration automatique. Une migration manuelle est requise.
| Enums | |
|---|---|
ERROR_UNSPECIFIED |
Type par défaut. |
DATAPROC_HUB |
L'UmN utilise Dataproc Hub et ne peut pas être migré. |
Méthodes |
|
|---|---|
|
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. |
|
Récupère la stratégie de contrôle d'accès d'une ressource. |
|
Vérifie si une instance de notebook est opérationnelle. |
|
Vérifie si une instance de notebook peut être mise à niveau. |
|
Liste les instances d'un projet et d'un emplacement donnés. |
|
Migre un notebook géré par l'utilisateur existant vers des instances Workbench. |
|
Enregistre une ancienne instance de notebook existante auprès du serveur de l'API Notebooks. |
|
Permet aux instances de notebook de communiquer les dernières informations les concernant au serveur de l'API Notebooks. |
|
Réinitialise une instance de notebook. |
|
Effectue un rollback d'une instance de notebook vers la version précédente. |
|
Met à jour les accélérateurs invités d'une seule instance. |
|
Définit la stratégie de contrôle d'accès de la ressource spécifiée. |
|
Remplace tous les libellés d'une instance. |
|
Met à jour le type de machine d'une seule instance. |
|
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. |
|
Mettre à jour les configurations des instances de notebook. |
|
Ajoutez ou mettez à jour des éléments de métadonnées pour une instance. |
|
Met à jour la configuration d'instance protégée d'une seule instance. |
|
Met à niveau une instance de notebook vers la dernière version. |