Method: projects.locations.instances.getInstanceHealth

Verifica se un'istanza notebook è integra.

Richiesta HTTP

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

Parametri del percorso

Parametri
name

string

Obbligatorio. Formato: projects/{projectId}/locations/{location}/instances/{instanceId}

L'autorizzazione richiede il seguente permesso IAM per la risorsa name specificata:

  • notebooks.instances.getHealth

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per verificare se un'istanza notebook è integra.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
Campi
healthState

enum (HealthState)

Solo output. Runtime healthState.
healthInfo

map (key: string, value: string)

Solo output. Informazioni aggiuntive sull'integrità dell'istanza. 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" }

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

HealthState

Se un'istanza è integra o meno.

Enum
HEALTH_STATE_UNSPECIFIED Il sottostato dell'istanza è sconosciuto.
HEALTHY È noto che l'istanza è in stato integro (ad esempio, i daemon critici sono in esecuzione). Si applica allo stato ACTIVE.
UNHEALTHY È noto che l'istanza è in uno stato non integro (ad esempio, i daemon critici non sono in esecuzione). Si applica allo stato ATTIVO.
AGENT_NOT_INSTALLED L'istanza non ha installato l'agente di monitoraggio dell'integrità. Si applica allo stato ATTIVO.
AGENT_NOT_RUNNING L'agente di monitoraggio dell'integrità dell'istanza non è in esecuzione. Si applica allo stato ATTIVO.