Method: projects.databases.restore

Crée une base de données en restaurant à partir d'une sauvegarde existante.

La nouvelle base de données doit se trouver dans la même région cloud ou l'emplacement multirégional que la sauvegarde existante. Ce fonctionnement est semblable à celui de [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], si ce n'est qu'au lieu de créer une base de données vide, une base de données est créée avec le type de base de données, la configuration d'index et les documents d'une sauvegarde existante.

long-running operation peut être utilisé pour suivre la progression de la restauration, le type de champ metadata de l'opération étant RestoreDatabaseMetadata. Le type response correspond à Database si la restauration a réussi. La nouvelle base de données n'est pas lisible ni accessible en écriture tant que l'opération de longue durée n'est pas terminée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Projet dans lequel restaurer la base de données. Format : projects/{projectId}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
databaseId

string

Obligatoire. ID à utiliser pour la base de données, qui deviendra le composant final du nom de ressource de la base de données. Cet ID de base de données ne doit pas être associé à une base de données existante.

Cette valeur doit comporter entre 4 et 63 caractères. Les caractères valides sont /[a-z][0-9]-/. Le premier caractère est une lettre, et le dernier une lettre ou un chiffre. Ne doit pas être de type UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

L'ID de base de données "(par défaut)" est également valide.

Champ d'union source.

source ne peut être qu'un des éléments suivants :

backup

string

Sauvegarde à partir de laquelle effectuer la restauration. Doit appartenir au même projet que le parent.

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.