Method: projects.databases.exportDocuments

Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie zmiany w dokumentach 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 eksportu zostanie anulowana przed ukończeniem, może pozostawić w Google Cloud Storage częściowe dane.

Żądanie HTTP

POST https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*}:exportDocuments

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Baza danych do wyeksportowania. Powinien mieć format: projects/{projectId}/databases/{databaseId}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Pola
collectionIds[]

string

Identyfikatory kolekcji do wyeksportowania. „Nieokreślony” oznacza wszystkie kolekcje.
outputUriPrefix

string

Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie: gs://BUCKET_NAME[/NAMESPACE_PATH], gdzie BUCKET_NAME to nazwa zasobnika Google Cloud Storage, a NAMESPACE_PATH to opcjonalna ścieżka przestrzeni nazw Google Cloud Storage. Wybierając nazwę, pamiętaj o przestrzeganiu wytycznych dotyczących nazewnictwa w Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jeśli identyfikator URI jest zasobnikiem (bez ścieżki przestrzeni nazw), na podstawie czasu rozpoczęcia zostanie wygenerowany prefiks.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała instancję Operation.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).