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

這個網址使用 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

執行個體類型，用於資料庫的 ID，會成為資料庫資源名稱的最終元件。這個資料庫 ID 不得與現有資料庫建立關聯。

此值長度應介於 4 至 63 個字元之間。有效的字元為 /[a-z][0-9]-/，開頭必須為英文字母，最後一個字母或數字。不得與 UUID 類似 /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。

「(預設)」資料庫 ID 也有效。

聯集欄位 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

詳情請參閱驗證總覽一文。