Checks whether a notebook instance is healthy.
HTTP request
GET https://notebooks.googleapis.com/v1/{name}:getInstanceHealth
Path parameters
Parameters | |
---|---|
name |
Required. Format: Authorization requires the following IAM permission on the specified resource
|
Request body
The request body must be empty.
Response body
Response for checking if a notebook instance is healthy.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"healthState": enum ( |
Fields | |
---|---|
health |
Output only. Runtime healthState. |
health |
Output only. Additional information about instance health. 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" } An object containing a list of |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
HealthState
If an instance is healthy or not.
Enums | |
---|---|
HEALTH_STATE_UNSPECIFIED |
The instance substate is unknown. |
HEALTHY |
The instance is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state. |
UNHEALTHY |
The instance is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state. |
AGENT_NOT_INSTALLED |
The instance has not installed health monitoring agent. Applies to ACTIVE state. |
AGENT_NOT_RUNNING |
The instance health monitoring agent is not running. Applies to ACTIVE state. |