Method: projects.databases.restore

Membuat database baru dengan memulihkan dari cadangan yang ada.

Database baru harus berada di region cloud atau lokasi multi-region yang sama dengan cadangan yang ada. Perilaku ini mirip dengan [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], tetapi bukannya membuat database baru yang kosong, database baru dibuat dengan jenis database, konfigurasi indeks, dan dokumen dari cadangan yang ada.

long-running operation dapat digunakan untuk melacak progres pemulihan, dengan jenis kolom metadata Operasi adalah RestoreDatabaseMetadata. Jenis response adalah Database jika pemulihan berhasil. Database baru tidak dapat dibaca atau ditulis hingga LRO selesai.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Project tempat database berada. Formatnya adalah projects/{projectId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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.
}
Kolom
databaseId

string

Wajib. ID yang akan digunakan untuk database, yang akan menjadi komponen akhir dari nama resource database. ID database ini tidak boleh dikaitkan dengan database yang sudah ada.

Nilai ini harus terdiri dari 4-63 karakter. Karakter yang valid adalah /[a-z][0-9]-/ dengan karakter pertama huruf dan huruf terakhir atau angka. Tidak boleh berbentuk UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

ID database "(default)" juga valid.

Kolom union source.

source hanya dapat berupa salah satu dari yang berikut:

backup

string

Cadangan untuk memulihkan. Harus berasal dari project yang sama dengan induk.

Formatnya adalah: projects/{projectId}/locations/{location}/backups/{backup}

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.