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

要求主體

要求主體必須為空白。

回應主體

檢查 Notebook 執行個體是否正常的相關回應。

如果成功，回應主體會含有以下結構的資料：

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 執行個體尚未安裝健康狀態監控代理程式。適用於「啟用」狀態。
AGENT_NOT_RUNNING 執行個體健康狀態監控代理程式未執行。適用於「啟用」狀態。