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

如需了解详情，请参阅身份验证概览。