Method: projects.locations.instances.getInstanceHealth

בודק אם מופע של מחברת תקין.

בקשת HTTP

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

פרמטרים של נתיב

פרמטרים
name

string

חובה. פורמט: projects/{projectId}/locations/{location}/instances/{instanceId}

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • 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

אם מופע תקין או לא.

טיפוסים בני מנייה (enum)
HEALTH_STATE_UNSPECIFIED מצב המשנה של המופע לא ידוע.
HEALTHY ידוע שהמופע במצב תקין (לדוגמה, שדים קריטיים פועלים). רלוונטי למצב ACTIVE.
UNHEALTHY ידוע שהמופע נמצא במצב לא תקין (לדוגמה, שדים קריטיים לא פועלים). חל על מצב ACTIVE.
AGENT_NOT_INSTALLED במופע לא הותקן סוכן מעקב אחרי תקינות. ההגדרה חלה על מצב פעיל.
AGENT_NOT_RUNNING הסוכן למעקב אחרי תקינות המופע לא פועל. ההגדרה חלה על מצב פעיל.