Method: projects.locations.instances.list

מפרט כל DatabaseInstance המשויך לפרויקט האב שצוין.

פריטי הרשימה מוחזרים ללא סדר מסוים, אך יהוו תצוגה עקבית של מופעי מסד הנתונים כאשר מבוצעות בקשות נוספות עם pageToken .

הרשימה המתקבלת מכילה מופעים בכל STATE .

תוצאות הרשימה עשויות להיות מיושנות בכמה שניות.

השתמש instances.get לקריאה עקבית.

בקשת HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

כתובת האתר משתמשת בתחביר GRPC Transcoding .

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

פרמטרים
parent

string

פרויקט האב שעבורו יש לרשום מופעי מסד נתונים, בצורה: projects/{project-number}/locations/{location-id}

כדי לרשום את כל המיקומים, השתמש בהורה בטופס: projects/{project-number}/locations/-

ההרשאה מחייבת את הרשאת IAM הבאה parent המשאב שצוין:

  • firebasedatabase.instances.list

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

פרמטרים
pageToken

string

אסימון הוחזר מקריאה קודמת ל- instances.list המציין היכן במערך מופעי מסד הנתונים לחדש את הרישום.

pageSize

integer

המספר המרבי של מופעי מסד נתונים שיש להחזיר בתגובה.

השרת עשוי להחזיר פחות מזה לפי שיקול דעתו. אם לא צוין ערך (או שצוין ערך גדול מדי), השרת יטיל מגבלה משלו.

showDeleted

boolean

ציין שיש להחזיר גם DatabaseInstances במצב DELETED .

גוף הבקשה

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

גוף תגובה

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

התגובה משיטת instances.list .

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

object ( DatabaseInstance )

רשימה של כל DatabaseInstance שנמצא בפרויקט האב של Firebase.

nextPageToken

string

אם רשימת התוצאות גדולה מכדי להתאים לתגובה בודדת, אזי מוחזר אסימון. אם המחרוזת ריקה, התגובה הזו היא הדף האחרון של התוצאות.

ניתן להשתמש באסימון זה בקריאה שלאחר מכן ל- instances.list כדי למצוא את הקבוצה הבאה של מופעי מסד נתונים.

אסימוני עמוד הם קצרי מועד ואין להתמיד בהם.

היקף ההרשאה

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

למידע נוסף, עיין בסקירת האימות .