Method: projects.locations.instances.list

הצגת רשימה של מופעים בפרויקט ובמיקום נתונים.

בקשת HTTP

GET https://notebooks.googleapis.com/v2/{parent}/instances

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

פרמטרים
parent

string

חובה. ההורה של המופע. פורמטים: – projects/{projectId}/locations/{location} כדי להציג רשימה של מכונות באזור ספציפי. ‫- projects/{projectId}/locations/- כדי להציג רשימה של מכונות בכל המיקומים.

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

  • notebooks.instances.list

פרמטרים של שאילתה

פרמטרים
pageSize

integer

זה שינוי אופציונלי. הגודל המקסימלי של התוצאות שיוחזרו בקריאה של רשימה.
pageToken

string

זה שינוי אופציונלי. טוקן של דף שהוחזר קודם, שאפשר להשתמש בו כדי להמשיך את הרשימה מהתוצאה האחרונה.
orderBy

string

זה שינוי אופציונלי. מיון התוצאות. הערכים הנתמכים הם name,‏ name desc או '' (לא ממוין).
filter

string

זה שינוי אופציונלי. מסנן רשימה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה לבקשה לרשימת מופעי נוטבוק.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
שדות
instances[]

object (Instance)

רשימה של מופעים שהוחזרו.
nextPageToken

string

טוקן דף שאפשר להשתמש בו כדי להמשיך את רשימת התוצאות מהתוצאה האחרונה בקריאה הבאה של הרשימה.
unreachable[]

string

רשימה לא ממוינת. מיקומים שלא ניתן להגיע אליהם. לדוגמה: ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']. התשובה ListInstancesResponse תכיל רק מופעים או רק מופעים שלא ניתן להגיע אליהם,

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

ניתן למצוא מידע נוסף כאן: Authentication Overview.