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
  • https://www.googleapis.com/auth/notebooks

詳細については、Authentication Overview をご覧ください。

HealthState

インスタンスが正常かどうか。

列挙型
HEALTH_STATE_UNSPECIFIED インスタンスのサブステートが不明です。
HEALTHY インスタンスが正常な状態であることがわかっている（たとえば、重要なデーモンが実行されている）。ACTIVE 状態に適用されます。
UNHEALTHY インスタンスが異常な状態であることがわかっています（たとえば、重要なデーモンが実行されていません）。ACTIVE 状態に適用されます。
AGENT_NOT_INSTALLED インスタンスにヘルス モニタリング エージェントがインストールされていません。ACTIVE 状態に適用されます。
AGENT_NOT_RUNNING インスタンスのヘルス モニタリング エージェントが実行されていません。ACTIVE 状態に適用されます。