Method: projects.databases.restore

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

מסד הנתונים החדש חייב להיות באותו אזור ענן או מיקום במספר אזורים כמו הגיבוי הקיים. הפעולה הזו מתנהגת כמו [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] אלא שבמקום ליצור מסד נתונים ריק חדש, נוצר מסד נתונים חדש עם סוג מסד הנתונים, תצורת האינדקס ומסמכים מגיבוי קיים.

ניתן להשתמש בקוד long-running operation כדי לעקוב אחר התקדמות השחזור, כאשר סוג השדה metadata של הפעולה הוא RestoreDatabaseMetadata. אם השחזור הצליח, הסוג response הוא Database. לא ניתן לקרוא או לכתוב את מסד הנתונים החדש עד לסיום ה-LRO.

בקשת HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*}/databases:restore

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
parent

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "databaseId": string,

  // Union field source can be only one of the following:
  "backup": string
  // End of list of possible types for union field source.
}
שדות
databaseId

string

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

הערך צריך להכיל 4-63 תווים. התווים החוקיים הם /[a-z][0-9]-/ כאשר התו הראשון הוא אות והתו האחרון הוא אות או מספר. לא חייב להיות דמוי-UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

גם מזהה מסד הנתונים '(ברירת מחדל)' חוקי.

שדה איחוד source.

source יכול להיות רק אחד מהבאים:
backup

string

גיבוי שממנו אפשר לשחזר. חייב להיות מאותו פרויקט של ההורה.

הפורמט הוא: projects/{projectId}/locations/{location}/backups/{backup}

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Operation.

היקפי הרשאות

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

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

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