Method: projects.databases.exportDocuments

這個外掛程式能將 Google Cloud Firestore 中全部或部分文件的副本匯出至其他儲存系統，例如 Google Cloud Storage。最近的文件更新可能不會反映在匯出作業中。匯出作業會在背景中執行，並透過建立的 Operation 資源監控及管理進度。執行匯出作業的輸出內容後，才能使用這些輸出內容。如果匯出作業在完成前遭到取消，可能會導致部分資料無法在 Google Cloud Storage 中留存。

HTTP 要求

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

這個網址使用 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

詳情請參閱驗證總覽一文。