既存のバックアップから復元して新しいデータベースを作成します。
新しいデータベースは、既存のバックアップと同じクラウド リージョンまたはマルチリージョン ロケーションに存在する必要があります。これは [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 |
必須。データベースを復元するプロジェクト。形式は |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "databaseId": string, // Union field |
フィールド | |
---|---|
databaseId |
必須。データベースに使用する ID。データベースのリソース名の最後のコンポーネントになります。このデータベース ID を既存のデータベースに関連付けることはできません。 この値は 4 ~ 63 文字で指定してください。有効な文字は /[a-z][0-9]-/ で、先頭は英字、最後の文字は英字または数字です。/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ のような UUID にすることはできません。 「(default)」データベース ID も有効です。 |
共用体フィールド
|
|
backup |
復元元のバックアップ。親と同じプロジェクトからのものである必要があります。 形式: |
レスポンスの本文
成功した場合、レスポンスの本文には Operation
のインスタンスが含まれます。
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。