列出指定項目(包括FirebaseProject
)的有效 Google Cloud Platform (GCP) 資源位置。
可以選擇這些位置之一作為專案的預設GCP 資源位置,這是預設配置專案資源(例如 Cloud Firestore)的地理位置。但是,如果已為項目設定預設 GCP 資源位置,則無法變更此設定。
此呼叫檢查指定項目的任何可能的位置限制,因此可能傳回所有可能的 GCP 資源位置的子集。若要列出所有 GCP 資源位置(無論有任何限制),請呼叫端點而不指定唯一項目識別碼(即/v1beta1/{parent=projects/-}/listAvailableLocations
)。
若要呼叫指定項目的availableLocations.list
,成員必須至少是專案的檢視者。沒有指定項目的呼叫不需要任何特定的項目權限。
HTTP請求
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
URL 使用gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent | 若要列出 GCP 資源位置的 有關PROJECT_IDENTIFIER值的詳細信息,請參閱 如果未指定唯一的項目識別碼(即, |
查詢參數
參數 | |
---|---|
pageToken | 從先前對 |
pageSize | 響應中傳回的最大位置數。 伺服器可能會自行決定傳回小於此值的值。如果未指定值(或指定的值太大),則伺服器將施加自己的限制。 該值不能為負數。 |
請求正文
請求內文必須為空。
響應體
如果成功,回應正文包含具有以下結構的資料:
JSON 表示 |
---|
{
"locations": [
{
object ( |
領域 | |
---|---|
locations[] | 呼叫 |
nextPageToken | 如果結果清單太大而無法容納單一回應,則傳回一個令牌。如果字串為空,則此回應是結果的最後一頁,並且已列出所有可用位置。 此令牌可用於後續呼叫 頁面令牌是短暫的,不應保留。 |
授權範圍
需要以下 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 ( |
領域 | |
---|---|
locationId | GCP 資源位置的 ID。它將成為可用的GCP 資源位置之一。 |
type | 指示 GCP 資源位置是用於資料複製的區域位置還是多區域位置。 |
features[] | GCP 資源位置中提供的產品和服務。 |
位置類型
指定如何在 GCP 資源位置內複製資料。詳細了解GCP 資源位置的類型。
列舉 | |
---|---|
LOCATION_TYPE_UNSPECIFIED | 在內部用於區分未設定的值,不適合外部使用。 |
REGIONAL | 此位置是區域位置。 區域位置中的資料會複製到區域內的多個區域。 |
MULTI_REGIONAL | 該位置是一個多區域位置。 多區域位置中的資料會複製到多個區域。在每個區域內,資料被複製到多個區域。 |
位置特徵
GCP 資源位置中提供的產品和服務。
列舉 | |
---|---|
LOCATION_FEATURE_UNSPECIFIED | 在內部用於區分未設定的值,不適合外部使用。 |
FIRESTORE | 此位置支援 Cloud Firestore 資料庫執行個體。 App Engine 在此位置可用,因此它可以是專案的預設 GCP 資源位置。 |
DEFAULT_STORAGE | 此位置支援預設 Cloud Storage 儲存分區。 App Engine 在此位置可用,因此它可以是專案的預設 GCP 資源位置。 |
FUNCTIONS | Cloud Functions for Firebase 在此位置上可用。 |