Method: projects.databases.restore

Cria um novo banco de dados restaurando a partir de um backup existente.

O novo banco de dados deve estar na mesma região de nuvem ou local multirregional que o backup existente. Isso se comporta de maneira semelhante a [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], exceto que, em vez de criar um novo banco de dados vazio, um novo banco de dados é criado com o tipo de banco de dados, configuração de índice e documentos de um backup existente.

A long-running operation pode ser usada para rastrear o progresso da restauração, com o tipo de campo metadata da Operação sendo RestoreDatabaseMetadata . O tipo response será o Database se a restauração tiver sido bem-sucedida. O novo banco de dados não poderá ser lido ou gravado até que a LRO seja concluída.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O projeto para restaurar o banco de dados. O formato é projects/{projectId} .

Solicitar corpo

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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.
}
Campos
databaseId

string

Obrigatório. O ID a ser usado para o banco de dados, que se tornará o componente final do nome do recurso do banco de dados. Este ID de banco de dados não deve estar associado a um banco de dados existente.

Este valor deve ter de 4 a 63 caracteres. Os caracteres válidos são /[az][0-9]-/ sendo o primeiro caractere uma letra e o último uma letra ou um número. Não deve ser do tipo UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

O ID do banco de dados "(padrão)" também é válido.

source do campo de união.

source pode ser apenas uma das seguintes:

backup

string

Backup para restaurar. Deve ser do mesmo projeto que o pai.

O formato é: projects/{projectId}/locations/{location}/backups/{backup}

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Operation .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .