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 인스턴스에 상태 모니터링 에이전트가 설치되어 있지 않습니다. 활성 상태에 적용됩니다.
AGENT_NOT_RUNNING 인스턴스 상태 모니터링 에이전트가 실행되고 있지 않습니다. 활성 상태에 적용됩니다.