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

有关详细信息,请参阅身份验证概述