Method: projects.databases.exportDocuments

將全部或部分文件的副本從 Google Cloud Firestore 匯出到另一個儲存系統,例如 Google Cloud Storage。最近對文件的更新可能不會反映在匯出中。匯出在背景進行,可以透過建立的操作資源監視和管理其進度。導出的輸出只能在相關操作完成後才能使用。如果匯出操作在完成之前取消,則可能會在 Google Cloud Storage 中留下部分資料。

HTTP請求

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

URL 使用gRPC 轉碼語法。

路徑參數

參數
name

string

要匯出的資料庫。應採用以下形式: projects/{projectId}/databases/{databaseId}

請求正文

請求正文包含具有以下結構的資料:

JSON 表示
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
領域
collectionIds[]

string

要匯出哪個集合 ID。未指定是指所有集合。

outputUriPrefix

string

輸出 URI。目前僅支援以下形式的 Google Cloud Storage URI: gs://BUCKET_NAME[/NAMESPACE_PATH] ,其中BUCKET_NAME是 Google Cloud Storage 儲存桶的名稱, NAMESPACE_PATH是可選的 Google Cloud Storage 命名空間路徑。選擇名稱時,請務必考慮 Google Cloud Storage 命名指南:https: //cloud.google.com/storage/docs/naming 。如果 URI 是儲存桶(沒有命名空間路徑),則會根據開始時間產生前綴。

響應體

如果成功,回應正文將包含一個Operation實例。

授權範圍

需要以下 OAuth 範圍之一:

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

有關詳細信息,請參閱身份驗證概述