Method: projects.locations.instances.getInstanceHealth

Verifica si una instancia de notebook está en buen estado.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
name

string

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

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • notebooks.instances.getHealth

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta para verificar si una instancia de notebook está en buen estado.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
Campos
healthState

enum (HealthState)

Solo salida. Es el healthState del entorno de ejecución.
healthInfo

map (key: string, value: string)

Solo salida. Es información adicional sobre el estado de la instancia. 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 objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

HealthState

Indica si una instancia está en buen estado o no.

Enums
HEALTH_STATE_UNSPECIFIED Se desconoce el subestado de la instancia.
HEALTHY Se sabe que la instancia está en buen estado (por ejemplo, los daemons críticos se están ejecutando). Se aplica al estado ACTIVE.
UNHEALTHY Se sabe que la instancia está en mal estado (por ejemplo, no se están ejecutando los daemons críticos). Se aplica al estado ACTIVE.
AGENT_NOT_INSTALLED La instancia no tiene instalado el agente de supervisión de estado. Se aplica al estado ACTIVE.
AGENT_NOT_RUNNING El agente de supervisión del estado de la instancia no se está ejecutando. Se aplica al estado ACTIVE.