Method: projects.databases.collectionGroups.fields.list

列出此数据库的字段配置和元数据。

目前，FirestoreAdmin.ListFields 仅支持列出已被明确替换的字段。如需发出此查询，请调用 FirestoreAdmin.ListFields，并将过滤条件设置为 indexConfig.usesAncestorConfig:false 或 ttlConfig:*。

HTTP 请求

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。格式为 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} 的父级名称

查询参数

参数
filter

string

要应用于列表结果的过滤条件。目前，FirestoreAdmin.ListFields 仅支持列出已被明确替换的字段。如需发出此查询，请使用包含 indexConfig.usesAncestorConfig:false 或 ttlConfig:* 的过滤条件调用 FirestoreAdmin.ListFields。
pageSize

integer

要返回的结果数。
pageToken

string

从上一次调用 FirestoreAdmin.ListFields 返回的页面令牌，可用于获取下一页结果。

请求正文

请求正文必须为空。

响应正文

FirestoreAdmin.ListFields 的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
字段
fields[]

object (Field)

所请求的字段。
nextPageToken

string

可用于请求另一页结果的页面令牌。如果留空，则这是最后一页。

授权范围

需要以下 OAuth 范围之一：

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

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