Method: projects.locations.list

列出有关此服务所支持位置的信息。此方法可通过以下两种方式调用:

  • 列出所有公开位置信息:使用路径 GET /v1/locations
  • 列出项目可见的位置:使用路径 GET /v1/projects/{projectId}/locations。这可能包括公共位置,以及项目专门可见的私密位置或其他位置。

HTTP 请求

GET https://vectorsearch.googleapis.com/v1/{name}/locations

路径参数

参数
name

string

包含位置信息集合的资源(如果适用)。

查询参数

参数
filter

string

用于将结果范围缩小至所需的特定子集的过滤条件。过滤语言接受 "displayName=tokyo" 等字符串,AIP-160 中对此进行了更详细的说明。

pageSize

integer

返回的结果数上限。如果未设置,则服务会选择默认值。

pageToken

string

从响应中的 nextPageToken 字段收到的页面标记。发送该页面令牌以接收后续页面。

extraLocationTypes[]

string

可选。请勿使用此字段。 除非另有明确说明,否则此字段不受支持且会被忽略。此字段主要供内部使用。

请求正文

请求正文必须为空。

响应正文

如果成功,则响应正文包含一个 ListLocationsResponse 实例。

授权范围

需要以下 OAuth 范围:

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

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

IAM 权限

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

  • vectorsearch.locations.list

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