Method: projects.locations.instances.getInstanceHealth

检查笔记本实例的运行状况是否良好。

HTTP 请求

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

路径参数

参数
name

string

必需。格式：projects/{projectId}/locations/{location}/instances/{instanceId}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

  • notebooks.instances.getHealth

请求正文

请求正文必须为空。

响应正文

用于检查笔记本实例是否正常的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "healthState": enum (HealthState),
  "healthInfo": {
    string: string,
    ...
  }
}
字段
healthState

enum (HealthState)

仅限输出。运行时 healthState。
healthInfo

map (key: string, value: string)

仅限输出。有关实例健康状况的其他信息。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" }

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 Authentication Overview。

HealthState

实例是否健康。

枚举
HEALTH_STATE_UNSPECIFIED 实例子状态未知。
HEALTHY 已知实例处于健康状态（例如，关键守护程序正在运行）。适用于 ACTIVE 状态。
UNHEALTHY 已知实例处于不健康状态（例如，关键守护程序未运行）。适用于 ACTIVE 状态。
AGENT_NOT_INSTALLED 实例未安装健康监控代理。适用于 ACTIVE 状态。
AGENT_NOT_RUNNING 实例健康状况监控代理未运行。适用于 ACTIVE 状态。