Method: projects.locations.instances.getInstanceHealth

Prüft, ob eine Notebook-Instanz fehlerfrei ist.

HTTP-Anfrage

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

Pfadparameter

Parameter
name

string

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

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name:

  • notebooks.instances.getHealth

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort auf die Frage, ob eine Notebook-Instanz fehlerfrei ist.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
Felder
healthState

enum (HealthState)

Nur Ausgabe. healthState der Laufzeit.
healthInfo

map (key: string, value: string)

Nur Ausgabe. Zusätzliche Informationen zum Instanzstatus. 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" }

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

HealthState

Gibt an, ob eine Instanz fehlerfrei ist.

Enums
HEALTH_STATE_UNSPECIFIED Der Unterstatus der Instanz ist unbekannt.
HEALTHY Die Instanz ist bekanntermaßen in einem fehlerfreien Zustand (z. B. werden kritische Daemons ausgeführt). Gilt für den Status „ACTIVE“.
UNHEALTHY Die Instanz ist bekanntermaßen fehlerhaft (z. B. werden kritische Daemons nicht ausgeführt). Gilt für den Status „AKTIV“.
AGENT_NOT_INSTALLED Auf der Instanz ist kein Agent für die Zustandsüberwachung installiert. Gilt für den Status „AKTIV“.
AGENT_NOT_RUNNING Der Agent für die Zustandsüberwachung der Instanz wird nicht ausgeführt. Gilt für den Status „AKTIV“.