Method: projects.availableLocations.list

Wyświetla listę prawidłowych lokalizacji zasobów Google Cloud Platform (GCP) dla określonego projektu (w tym FirebaseProject ).

Jedną z tych lokalizacji można wybrać jako domyślną lokalizację zasobu GCP Projektu, czyli lokalizację geograficzną, w której zasoby Projektu, takie jak Cloud Firestore, będą domyślnie udostępniane. Jeśli jednak dla projektu została już ustawiona domyślna lokalizacja zasobu GCP, ustawienia tego nie można zmienić.

To wywołanie sprawdza wszelkie możliwe ograniczenia lokalizacji dla określonego projektu i dlatego może zwrócić podzbiór wszystkich możliwych lokalizacji zasobów GCP. Aby wyświetlić listę wszystkich lokalizacji zasobów GCP (niezależnie od jakichkolwiek ograniczeń), wywołaj punkt końcowy bez podawania unikalnego identyfikatora projektu (tzn. /v1beta1/{parent=projects/-}/listAvailableLocations ).

Aby wywołać availableLocations.list z określonym projektem, członek musi być co najmniej osobą przeglądającą projekt. Wywołania bez określonego projektu nie wymagają żadnych konkretnych uprawnień do projektu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC .

Parametry ścieżki

Parametry
parent

string

FirebaseProject , dla którego chcesz wyświetlić listę lokalizacji zasobów GCP, w formacie:

projects/ PROJECT_IDENTIFIER

Szczegółowe informacje na temat wartości PROJECT_IDENTIFIER można znaleźć w polu name FirebaseProject .

Jeśli nie określono żadnego unikalnego identyfikatora projektu (tzn. projects/- ), zwrócona lista nie uwzględnia ograniczeń lokalizacji specyficznych dla organizacji lub projektu.

Parametry zapytania

Parametry
pageToken

string

Token zwrócony z poprzedniego wywołania do availableLocations.list wskazujący, gdzie na liście lokalizacji należy wznowić wystawianie.

pageSize

integer

Maksymalna liczba lokalizacji, które mają zostać zwrócone w odpowiedzi.

Serwer może według własnego uznania zwrócić mniej niż ta wartość. Jeśli nie zostanie określona żadna wartość (lub zostanie określona wartość zbyt duża), serwer narzuci własny limit.

Wartość ta nie może być ujemna.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli się powiedzie, treść odpowiedzi zawiera dane o następującej strukturze:

Reprezentacja JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Pola
locations[]

object ( Location )

Jedna strona wyników wywołania availableLocations.list .

nextPageToken

string

Jeśli lista wyników jest zbyt duża, aby zmieścić się w jednej odpowiedzi, zwracany jest token. Jeśli ciąg znaków jest pusty, to ta odpowiedź jest ostatnią stroną wyników i zostały wyszczególnione wszystkie dostępne lokalizacje.

Tego tokena można użyć w kolejnym wywołaniu availableLocations.list w celu znalezienia większej liczby lokalizacji.

Tokeny strony są krótkotrwałe i nie należy ich utrwalać.

Zakresy autoryzacji

Wymaga jednego z następujących zakresów 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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Lokalizacja

Lokalizacja zasobu GCP, którą można wybrać dla FirebaseProject .

Reprezentacja JSON
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Pola
locationId

string

Identyfikator lokalizacji zasobu GCP. Będzie to jedna z dostępnych lokalizacji zasobów GCP .

type

enum ( LocationType )

Wskazuje, czy lokalizacja zasobu GCP jest lokalizacją regionalną czy wieloregionalną na potrzeby replikacji danych.

features[]

enum ( LocationFeature )

Produkty i usługi dostępne w lokalizacji zasobów GCP.

Typ Lokacji

Określa sposób replikacji danych w lokalizacji zasobu GCP. Dowiedz się więcej o typach lokalizacji zasobów GCP .

Wyliczenia
LOCATION_TYPE_UNSPECIFIED Używany wewnętrznie do rozróżniania nieustawionych wartości i nie jest przeznaczony do użytku zewnętrznego.
REGIONAL

Lokalizacja jest lokalizacją regionalną.

Dane w lokalizacji regionalnej są replikowane w wielu strefach w obrębie regionu.

MULTI_REGIONAL

Lokalizacja ma charakter wieloregionalny.

Dane w lokalizacji obejmującej wiele regionów są replikowane w wielu regionach. W każdym regionie dane są replikowane w wielu strefach.

LokalizacjaFunkcja

Produkty i usługi dostępne w lokalizacji zasobów GCP.

Wyliczenia
LOCATION_FEATURE_UNSPECIFIED Używany wewnętrznie do rozróżniania nieustawionych wartości i nie jest przeznaczony do użytku zewnętrznego.
FIRESTORE

Ta lokalizacja obsługuje instancje bazy danych Cloud Firestore.

App Engine jest dostępny w tej lokalizacji, więc może to być domyślna lokalizacja zasobu GCP projektu.

DEFAULT_STORAGE

Ta lokalizacja obsługuje domyślne zasobniki Cloud Storage.

App Engine jest dostępny w tej lokalizacji, więc może to być domyślna lokalizacja zasobu GCP projektu.

FUNCTIONS Cloud Functions dla Firebase są dostępne w tej lokalizacji.