Method: projects.databases.restore

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

O novo banco de dados precisa estar na mesma região de nuvem ou local multirregional que o backup atual. O comportamento é 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, a configuração de índice e os documentos de um backup existente.

O long-running operation pode ser usado para acompanhar o progresso da restauração, sendo o tipo de campo metadata da operação o RestoreDatabaseMetadata. O tipo response será o Database se a restauração for bem-sucedida. O novo banco de dados não será legível nem gravável até que a LRO seja concluída.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O projeto em que o banco de dados será restaurado. O formato é projects/{projectId}.

Corpo da solicitação

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 no banco de dados, que se tornará o componente final do nome do recurso do banco de dados. Esse ID de banco de dados não pode estar associado a um banco de dados existente.

Esse valor precisa ter de 4 a 63 caracteres. Os caracteres válidos são /[a-z][0-9]-/ com o primeiro caractere uma letra e o último uma letra ou um número. Não pode ser semelhante a UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

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

Campo de união source.

source pode ser apenas de um dos tipos a seguir:
backup

string

Backup a ser restaurado. Precisa ser do mesmo projeto que o pai.

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.