Method: projects.locations.collections.list

获取 Collection 的列表。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/collections

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级数据存储区资源名称，格式为 projects/{project}/locations/{location}。

查询参数

参数
pageSize

integer

要返回的 Collection 数量上限。服务返回的值可能小于此值。

如果未指定，则最多返回 100 个 Collection。

最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
pageToken

string

从之前的 CollectionService.ListCollections 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 CollectionService.ListCollections 的所有其他参数必须与提供页面令牌的调用匹配。
filter

string

按关联的数据连接器数据源过滤返回的集合。例如：filter = 'dataSource:jira confluence'。如果过滤条件为空，则返回项目和位置下的所有集合。

请求正文

请求正文必须为空。

响应正文

CollectionService.ListCollections 方法的响应消息。

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

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

object (Collection)

Collection。
nextPageToken

string

可作为 ListCollectionsRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.collections.list

如需了解详情，请参阅 IAM 文档。