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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
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}/ にすることはできません。

"(default)"データベース 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

詳細については、認証の概要をご覧ください。