REST Resource: projects.locations.instances

משאב: DatabaseInstance

ייצוג מופע של מסד נתונים בזמן אמת. ניתן למצוא פרטים על אינטראקציה עם תוכן של DatabaseInstance בכתובת: https://firebase.google.com/docs/database/rest/start .

ייצוג JSON
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
שדות
name

string

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

project

string

פלט בלבד. שם המשאב של הפרויקט שאליו שייך מופע זה. לדוגמה: projects/{project-number} .

databaseUrl

string

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

type

enum ( DatabaseInstanceType )

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

state

enum ( State )

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

DatabaseInstanceType

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

תקצירים
DATABASE_INSTANCE_TYPE_UNSPECIFIED מצב לא ידוע, כנראה תוצאה של שגיאה ב-backend. זה משמש רק להבחין בין ערכים לא מוגדרים.
DEFAULT_DATABASE מסד הנתונים המוגדר כברירת מחדל המוקצה בעת יצירת פרוייקט.
USER_DATABASE מסד נתונים שהמשתמש יצר.

מדינה

מצבי מחזור חיים של מסד נתונים.

תקצירים
LIFECYCLE_STATE_UNSPECIFIED מצב לא מוגדר, כנראה תוצאה של שגיאה ב-backend. זה משמש רק להבחין בין ערכים לא מוגדרים.
ACTIVE המצב הרגיל והפעיל.
DISABLED מסד הנתונים נמצא במצב מושבת. ניתן להפעיל אותו מחדש מאוחר יותר.
DELETED מסד הנתונים נמצא במצב נמחק.

שיטות

create

 מבקש ליצור DatabaseInstance חדש.

delete

 מסמן מופע DatabaseInstance למחיקה.

disable

 משבית DatabaseInstance .

get

 מקבל את DatabaseInstance המזוהה לפי שם המשאב שצוין.

list

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

reenable

 מאפשר DatabaseInstance .

undelete

 משחזר DatabaseInstance שסומן בעבר למחיקה.