Method: projects.locations.instances.getConfig

Renvoie différents paramètres de configuration.

Requête HTTP

GET https://notebooks.googleapis.com/v2/{name}/instances:getConfig

Paramètres de chemin

Paramètres
name

string

Obligatoire. Format : projects/{projectId}/locations/{location}

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour obtenir les configurations WbI dans un lieu

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "defaultValues": {
    object (DefaultValues)
  },
  "supportedValues": {
    object (SupportedValues)
  },
  "availableImages": [
    {
      object (ImageRelease)
    }
  ],
  "disableWorkbenchLegacyCreation": boolean
}
Champs
defaultValues

object (DefaultValues)

Uniquement en sortie. Valeurs par défaut de la configuration.
supportedValues

object (SupportedValues)

Uniquement en sortie. Valeurs acceptées pour la configuration.
availableImages[]

object (ImageRelease)

Uniquement en sortie. Liste des images disponibles pour créer un fichier WbI.
disableWorkbenchLegacyCreation

boolean

Uniquement en sortie. Indicateur permettant de désactiver la création d'anciens notebooks Workbench (notebooks gérés par l'utilisateur et notebooks gérés par Google).

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.

DefaultValues

DefaultValues représente les valeurs de configuration par défaut.

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

string

Uniquement en sortie. Type de machine par défaut utilisé par le backend s'il n'est pas fourni par l'utilisateur.

SupportedValues

SupportedValues représente les valeurs acceptées par la configuration.

Représentation JSON 
{
  "machineTypes": [
    string
  ],
  "acceleratorTypes": [
    string
  ]
}
Champs
machineTypes[]

string

Uniquement en sortie. Types de machines compatibles avec WbI.
acceleratorTypes[]

string

Uniquement en sortie. Types d'accélérateurs compatibles avec WbI.

ImageRelease

ConfigImage représente une version d'image disponible pour créer une instance Workbench.

Représentation JSON 
{
  "imageName": string,
  "releaseName": string,
  "imageFamily": string,
  "description": string
}
Champs
imageName

string

Uniquement en sortie. Nom de l'image au format workbench-instances-vYYYYmmdd--
releaseName

string

Uniquement en sortie. Publication de l'image du formulaire m123
imageFamily

string

Uniquement en sortie. Famille d'images de l'image. (par exemple, "workbench-instances" ou "workbench-2603")
description

string

Uniquement en sortie. Description de l'image.