Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage. Es posible que las actualizaciones recientes de los documentos no se reflejen en la exportación. La exportación ocurre en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. La salida de una exportación solo se puede utilizar una vez que se realiza la operación asociada. Si una operación de exportación se cancela antes de completarse, puede dejar datos parciales en Google Cloud Storage.
Solicitud HTTP
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments
La URL utiliza la sintaxis de transcodificación gRPC .
Parámetros de ruta
Parámetros | |
---|---|
name | Requerido. Base de datos para exportar. Debe tener el formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON | |
---|---|
{ "collectionIds": [ string ], "outputUriPrefix": string } |
Campos | |
---|---|
collectionIds[] | Qué identificadores de colección exportar. Sin especificar significa todas las colecciones. |
outputUriPrefix | El URI de salida. Actualmente solo admite URI de Google Cloud Storage con el formato: |
Cuerpo de respuesta
Si tiene éxito, el cuerpo de la respuesta contiene una instancia de Operation
.
Ámbitos de autorización
Requiere uno de los siguientes ámbitos de OAuth:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulte la descripción general de la autenticación .