Method: projects.availableLocations.list

列出指定專案的有效 Google Cloud Platform (GCP) 資源位置 (包括 FirebaseProject)。

您可以將其中一個位置選為專案的預設 GCP 資源位置，這是系統根據預設佈建專案資源 (例如 Cloud Firestore) 的地理位置。然而，如果已為專案設定預設 GCP 資源位置，就無法變更這項設定。

這項呼叫會檢查指定專案是否有任何可能的位置限制，因此可能會傳回所有可能 GCP 資源位置的一部分。如要列出所有 GCP 資源位置 (不受任何限制)，請在呼叫端點時不指定專屬專案 ID (即 /v1beta1/{parent=projects/-}/listAvailableLocations)。

如要透過指定專案呼叫 availableLocations.list，成員必須至少具備專案檢視者權限。沒有指定專案的呼叫不需要任何特定專案權限。

HTTP 要求

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

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

路徑參數

參數
parent

string

要列出 GCP 資源位置的 FirebaseProject，格式為：

projects/PROJECT_IDENTIFIER

如要進一步瞭解 PROJECT_IDENTIFIER 值，請參閱 FirebaseProject name 欄位。

如未指定專屬專案 ID (也就是 projects/-)，傳回的清單就不會考量機構或專案的專屬位置限制。

查詢參數

參數
pageToken

string

從先前對 availableLocations.list 的呼叫傳回的權杖，指出要恢復刊登資訊的位置清單中的哪個位置。
pageSize

integer

要在回應中傳回的地點數量上限。

伺服器可自行斟酌是否傳回少於這個值。如未指定任何值 (或指定太大的值)，伺服器會自行限制值。

此值不能為負數。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
欄位
locations[]

object (Location)

呼叫 availableLocations.list 的一頁結果。
nextPageToken

string

如果結果清單過大，無法容納單一回應，系統會傳回符記。如果字串空白，表示這個回應是結果的最後一頁，且已列出所有可用位置。

這個權杖可以在後續呼叫 availableLocations.list 時使用，以找出更多地點。

頁面符記效期短暫，不應保留。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

詳情請參閱驗證總覽一文。

位置

可為 FirebaseProject 選取的 GCP 資源位置。

JSON 表示法 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
欄位
locationId

string

GCP 資源位置的 ID。該位置會是其中一個可用的 GCP 資源位置。
type

enum (LocationType)

指出 GCP 資源位置是單一區域或多區域位置來複製資料。
features[]

enum (LocationFeature)

GCP 資源位置提供的產品和服務。

LocationType

指定如何在 GCP 資源位置複製資料。進一步瞭解 GCP 資源位置類型。

列舉
LOCATION_TYPE_UNSPECIFIED 可在內部用來區分未設定的值，並不適合外部使用。
REGIONAL

位置為單一區域位置，

單一區域位置中的資料會在地區內的多個可用區中複製。
MULTI_REGIONAL

位置是多區域位置，

多區域位置中的資料會在多個區域中複製，而在每個區域內，資料會複製到多個可用區。

LocationFeature

GCP 資源位置提供的產品和服務。

列舉
LOCATION_FEATURE_UNSPECIFIED 可在內部用來區分未設定的值，並不適合外部使用。
FIRESTORE

這個位置支援 Cloud Firestore 資料庫執行個體。

App Engine 可在這個位置使用，因此可以是專案的預設 GCP 資源位置。
DEFAULT_STORAGE

這個位置支援預設的 Cloud Storage 值區。

App Engine 可在這個位置使用，因此可以是專案的預設 GCP 資源位置。
FUNCTIONS 這個位置可以使用 Cloud Functions for Firebase。