Method: projects.databases.collectionGroups.fields.list

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

目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请调用FirestoreAdmin.ListFields并将过滤器设置为indexConfig.usesAncestorConfig:false

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

查询参数

参数
filter

string

应用到列表结果的过滤器。目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请调用FirestoreAdmin.ListFields并将过滤器设置为indexConfig.usesAncestorConfig:false

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

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