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

詳情請參閱驗證總覽。