מפרט את מיקומי המשאבים החוקיים של Google Cloud Platform (GCP) עבור הפרויקט שצוין (כולל FirebaseProject
).
ניתן לבחור אחד מהמיקומים האלה כמיקום ברירת המחדל של משאב GCP של הפרויקט , שהוא המיקום הגיאוגרפי שבו יסופקו משאבי הפרויקט, כגון Cloud Firestore, כברירת מחדל. עם זאת, אם מיקום ברירת המחדל של משאב GCP כבר הוגדר עבור הפרויקט, לא ניתן לשנות הגדרה זו.
קריאה זו בודקת מגבלות מיקום אפשריות עבור הפרויקט שצוין, ולכן עשויה להחזיר תת-קבוצה של כל מיקומי המשאבים האפשריים של GCP. כדי לרשום את כל מיקומי המשאבים של GCP (ללא קשר להגבלות כלשהן), התקשר לנקודת הקצה מבלי לציין מזהה פרויקט ייחודי (כלומר, /v1beta1/{parent=projects/-}/listAvailableLocations
).
כדי להתקשר availableLocations.list
עם פרויקט מוגדר, חבר חייב להיות לפחות צופה בפרויקט. שיחות ללא פרויקט מוגדר אינן דורשות הרשאות ספציפיות לפרויקט.
בקשת HTTP
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
כתובת האתר משתמשת בתחביר GRPC Transcoding .
פרמטרים של נתיב
פרמטרים | |
---|---|
parent | עיין בשדה אם לא צוין מזהה פרויקט ייחודי (כלומר, |
פרמטרי שאילתה
פרמטרים | |
---|---|
pageToken | אסימון הוחזר משיחה קודמת ל- |
pageSize | המספר המרבי של מיקומים להחזיר בתגובה. השרת עשוי להחזיר פחות מהערך הזה לפי שיקול דעתו. אם לא צוין ערך (או שצוין ערך גדול מדי), השרת יטיל מגבלה משלו. ערך זה לא יכול להיות שלילי. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף תגובה
אם זה מצליח, גוף התגובה מכיל נתונים עם המבנה הבא:
ייצוג JSON |
---|
{
"locations": [
{
object ( |
שדות | |
---|---|
locations[] | דף אחד של תוצאות משיחה ל- |
nextPageToken | אם רשימת התוצאות גדולה מכדי להתאים לתגובה בודדת, אזי מוחזר אסימון. אם המחרוזת ריקה, התגובה הזו היא הדף האחרון של התוצאות וכל המיקומים הזמינים נרשמו. ניתן להשתמש באסימון זה בקריאה שלאחר מכן אל אסימוני עמוד הם קצרי מועד ואין להתמיד בהם. |
היקף ההרשאה
דורש אחד מהיקפי 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
למידע נוסף, עיין בסקירת האימות .
מקום
מיקום משאב GCP שניתן לבחור עבור FirebaseProject
.
ייצוג JSON |
---|
{ "locationId": string, "type": enum ( |
שדות | |
---|---|
locationId | המזהה של מיקום המשאב של GCP. זה יהיה אחד ממיקומי המשאבים הזמינים של GCP . |
type | מציין אם מיקום המשאב של GCP הוא מיקום אזורי או רב-אזורי לשכפול נתונים. |
features[] | מוצרים ושירותים הזמינים במיקום המשאב של GCP. |
LocationType
מציין כיצד נתונים משוכפלים בתוך מיקום המשאב של GCP. למידע נוסף על סוגי מיקומי המשאבים של GCP .
תקצירים | |
---|---|
LOCATION_TYPE_UNSPECIFIED | משמש באופן פנימי להבחין בין ערכים לא מוגדרים ואינו מיועד לשימוש חיצוני. |
REGIONAL | המיקום הוא מיקום אזורי. נתונים במיקום אזורי משוכפלים במספר אזורים בתוך אזור. |
MULTI_REGIONAL | המיקום הוא מיקום רב אזורי. נתונים במיקום מרובה אזורים משוכפלים באזורים מרובים. בתוך כל אזור, נתונים משוכפלים באזורים מרובים. |
תכונת מיקום
מוצרים ושירותים הזמינים במיקום המשאב של GCP.
תקצירים | |
---|---|
LOCATION_FEATURE_UNSPECIFIED | משמש באופן פנימי להבחין בין ערכים לא מוגדרים ואינו מיועד לשימוש חיצוני. |
FIRESTORE | מיקום זה תומך במופעי מסד נתונים של Cloud Firestore. App Engine זמין במיקום זה, כך שהוא יכול להיות מיקום ברירת המחדל של משאב GCP של פרויקט . |
DEFAULT_STORAGE | מיקום זה תומך בדליי ברירת מחדל של Cloud Storage. App Engine זמין במיקום זה, כך שהוא יכול להיות מיקום ברירת המחדל של משאב GCP של פרויקט . |
FUNCTIONS | Cloud Functions for Firebase זמינות במיקום זה. |