這個外掛程式能將 Google Cloud Firestore 中所有或部分文件的副本匯出至其他儲存系統,例如 Google Cloud Storage。近期對文件所做的更新可能不會反映在匯出檔案中。匯出作業會在背景中執行,您可以透過已建立的 Operation 資源來監控及管理進度。只有在相關作業完成後,才能使用匯出結果。如在匯出作業完成前取消,部分資料可能仍會留在 Google Cloud Storage 中。
如要進一步瞭解匯出行為和輸出格式,請參閱:https://cloud.google.com/firestore/docs/manage-data/export-import
HTTP 要求
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。要匯出的資料庫。格式應為 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
欄位 | |
---|---|
collectionIds[] |
要匯出的集合 ID。「未指定」:表示所有集合。 |
outputUriPrefix |
輸出 URI。目前僅支援以下格式的 Google Cloud Storage URI: |
namespaceIds[] |
空白清單代表所有命名空間。這適合不使用命名空間的資料庫使用, 空字串元素代表預設的命名空間。如果資料庫在非預設命名空間中存有資料,但不想納入這些資料,則應使用這個選項。這份清單中的每個命名空間不得重複。 |
snapshotTime |
時間戳記,對應至待匯出的資料庫版本。時間戳記必須是過去的時間 (四捨五入至分鐘),且不得早於 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
回應主體
如果成功,回應主體會包含 Operation
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。