Eksportuje kopię wszystkich dokumentów lub ich podzbioru z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie aktualizacje dokumentów mogą nie zostać uwzględnione w eksporcie. Eksport odbywa się w tle, a jego postęp można monitorować i zarządzać nim za pomocą tworzonego zasobu operacji. Danych wyjściowych eksportu można użyć dopiero po zakończeniu powiązanej operacji. Jeśli operacja eksportowania zostanie anulowana przed zakończeniem, może ona pozostawić w Google Cloud Storage częściowe dane.
Więcej informacji o sposobie eksportowania i formacie danych wyjściowych znajdziesz na https://cloud.google.com/firestore/docs/manage-data/export-import
Żądanie HTTP
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
name |
Wymagane. Baza danych do wyeksportowania. Powinien mieć taki format: |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
Pola | |
---|---|
collectionIds[] |
Identyfikatory kolekcji do wyeksportowania. Nieokreślone oznacza wszystkie kolekcje. |
outputUriPrefix |
Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie |
namespaceIds[] |
Pusta lista zawiera wszystkie przestrzenie nazw. Jest to preferowane użycie w przypadku baz danych, które nie korzystają z przestrzeni nazw. Pusty element ciągu to domyślna przestrzeń nazw. Należy go używać, jeśli baza danych zawiera dane w innych przestrzeniach nazw, ale nie chce ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna. |
snapshotTime |
Sygnatura czasowa odpowiadająca wersji bazy danych do wyeksportowania. Sygnatura czasowa musi być datą przeszłą i zaokrąglona do minuty. Nie może być starsza niż Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.