Method: folders.locations.list

列出這項服務支援位置的相關資訊。

這個方法會根據 [ListLocationsRequest.name] 欄位中提供的資源範圍，列出位置：

  • 全球位置：如果 name 為空白，這個方法會列出所有專案可用的公開位置。
  • 專案專屬位置：如果 name 遵循 projects/{project} 格式，這個方法會列出該特定專案可見的位置。包括專案啟用時的公開、私人或其他專案專屬位置。

如果是 gRPC 和用戶端程式庫實作，資源名稱會以 name 欄位傳遞。如果是直接服務呼叫，系統會根據特定服務的實作項目和版本，將資源名稱併入要求路徑。

HTTP 要求

GET https://observability.googleapis.com/v1/{name=folders/*}/locations

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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 權限：

  • observability.locations.list

詳情請參閱 IAM 說明文件。