Method: projects.locations.instances.getInstanceHealth

Vérifie si une instance de notebook est opérationnelle.

Requête HTTP

GET https://notebooks.googleapis.com/v1/{name}:getInstanceHealth

Paramètres de chemin

Paramètres
name

string

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

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.getHealth

Corps de la requête

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

Corps de la réponse

Réponse pour vérifier si une instance de notebook est opérationnelle.

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

Représentation JSON 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
Champs
healthState

enum (HealthState)

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

map (key: string, value: string)

Uniquement en sortie. Informations supplémentaires sur l'état de l'instance. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }

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

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.

HealthState

Indique si une instance est opérationnelle ou non.

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.