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 說明文件