Method: projects.locations.instances.getInstanceHealth

Verifica se uma instância de notebook está íntegra.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Formato: projects/{projectId}/locations/{location}/instances/{instanceId}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.getHealth

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para verificar se uma instância de notebook está íntegra.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
Campos
healthState

enum (HealthState)

Apenas saída. Runtime healthState.
healthInfo

map (key: string, value: string)

Apenas saída. Informações adicionais sobre a integridade da instância. 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" }

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

HealthState

Se uma instância está íntegra ou não.

Tipos enumerados
HEALTH_STATE_UNSPECIFIED O subestado da instância é desconhecido.
HEALTHY A instância está em um estado íntegro (por exemplo, daemons críticos estão em execução). Aplica-se ao estado ATIVO.
UNHEALTHY A instância está em um estado não íntegro (por exemplo, daemons críticos não estão em execução). Aplica-se ao estado ACTIVE.
AGENT_NOT_INSTALLED A instância não tem o agente de monitoramento de integridade instalado. Aplicável ao estado ATIVO.
AGENT_NOT_RUNNING O agente de monitoramento de integridade da instância não está em execução. Aplicável ao estado ATIVO.