Method: projects.locations.list

列出有關此服務支援的位置的資訊。

HTTP請求

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

URL 使用gRPC 轉碼語法。

路徑參數

參數
name

string

擁有位置集合的資源(如果適用)。

查詢參數

參數
filter

string

用於將結果縮小到首選子集的篩選器。過濾語言接受類似"displayName=tokyo"的字串,並在AIP-160中有更詳細的記錄。

pageSize

integer

要傳回的最大結果數。如果未設置,服務將選擇預設值。

pageToken

string

從回應中的nextPageToken欄位接收的頁面令牌。發送該頁面令牌以接收後續頁面。

請求正文

請求內文必須為空。

響應體

Locations.ListLocations的回應訊息。

如果成功,回應正文包含具有以下結構的資料:

JSON 表示
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
領域
locations[]

object ( Location )

與請求中指定過濾器相符的位置清單。

nextPageToken

string

標準清單下一頁標記。

授權範圍

需要以下 OAuth 範圍之一:

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

有關詳細信息,請參閱身份驗證概述