Method: projects.databases.restore

Crea una base de datos nueva mediante el restablecimiento desde una copia de seguridad existente.

La base de datos nueva debe estar en la misma región de la nube o ubicación multirregional que la copia de seguridad existente. Este comportamiento es similar a [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], excepto que, en lugar de crear una nueva base de datos vacía, se crea una nueva con el tipo de base de datos, la configuración de índice y los documentos de una copia de seguridad existente.

long-running operation se puede usar para hacer un seguimiento del progreso del restablecimiento, y el tipo de campo metadata de la operación es RestoreDatabaseMetadata. El tipo response es Database si el restablecimiento se realizó correctamente. La nueva base de datos no se podrá leer ni escribir hasta que se complete la LRO.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. El proyecto en el que se restablecerá la base de datos. El formato es projects/{projectId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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

Obligatorio. Es el ID que se usará para la base de datos, que se convertirá en el componente final del nombre del recurso de la base de datos. Este ID de la base de datos no debe estar asociado a una base de datos existente.

Este valor debe tener entre 4 y 63 caracteres. Los caracteres válidos son /[a-z][0-9]-/, donde el primer carácter es una letra y, el último, una letra o un número. No debe ser similar a un UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

“(predeterminado)” el ID de la base de datos también es válido.

Campo de unión source.

source puede ser una de las siguientes opciones:
backup

string

Copia de seguridad desde la que se realizará restablecimiento. Debe ser del mismo proyecto que el elemento superior.

Formato: projects/{projectId}/locations/{location}/backups/{backup}

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.