Method: projects.locations.collections.indexes.list

列出给定项目和位置中的索引。

HTTP 请求

GET https://vectorsearch.googleapis.com/v1beta/{parent}/indexes

路径参数

参数
parent

string

必需。ListIndexesRequest 的父级值

查询参数

参数
pageSize

integer

可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

pageToken

string

可选。标识服务器应返回的结果页面的令牌。

filter

string

可选。过滤结果

orderBy

string

可选。有关如何对结果进行排序的提示

请求正文

请求正文必须为空。

响应正文

对列出索引的响应消息

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

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

object (Index)

索引列表

nextPageToken

string

标识服务器应返回的结果页面的令牌。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 Authentication Overview

IAM 权限

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

  • vectorsearch.indexes.list

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