Zawiera listę prawidłowych lokalizacji zasobów Google Cloud Platform (GCP) dla określonego projektu (w tym FirebaseProject
).
Jedna z tych lokalizacji można wybrać jako domyślną lokalizację zasobów GCP projektu, czyli lokalizację geograficzną, w której zasoby projektu, takie jak Cloud Firestore, będą domyślnie udostępniane. Jeśli jednak domyślna lokalizacja zasobu GCP została już ustawiona dla projektu, nie można zmienić tego ustawienia.
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 (bez względu na ograniczenia), wywołaj punkt końcowy bez określania unikalnego identyfikatora projektu (czyli /v1beta1/{parent=projects/-}/listAvailableLocations
).
Aby móc wywołać funkcję availableLocations.list
przy użyciu określonego projektu, użytkownik musi mieć co najmniej uprawnienia wyświetlającego projekt. Wywołania bez określonego projektu nie wymagają żadnych uprawnień w projekcie.
Żądanie HTTP
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
Pole
Szczegółowe informacje o wartościach PROJECT_IDENTIFIER znajdziesz w polu Jeśli nie określono unikalnego identyfikatora projektu (czyli |
Parametry zapytania
Parametry | |
---|---|
pageToken |
Token zwrócony z poprzedniego wywołania funkcji |
pageSize |
Maksymalna liczba lokalizacji do zwrócenia w odpowiedzi. Serwer może zwrócić mniej niż ta wartość według własnego uznania. Jeśli nie podasz żadnej wartości (lub podasz za dużą wartość), serwer nałoży własny limit. Ta wartość nie może być ujemna. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"locations": [
{
object ( |
Pola | |
---|---|
locations[] |
Jedna strona wyników połączenia z numerem |
nextPageToken |
Jeśli lista wyników jest zbyt duża, aby zmieścić się w pojedynczej odpowiedzi, zwracany jest token. Jeśli ciąg jest pusty, ta odpowiedź to ostatnia strona wyników, a wszystkie dostępne lokalizacje są wymienione. Tego tokena można użyć w kolejnym wywołaniu funkcji Tokeny stron mają krótki czas życia i nie powinny być zachowywane. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów protokołu 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
Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Lokalizacja
Lokalizacja zasobu GCP, którą można wybrać dla FirebaseProject
.
Zapis JSON |
---|
{ "locationId": string, "type": enum ( |
Pola | |
---|---|
locationId |
Identyfikator lokalizacji zasobu GCP. Będzie to jedna z dostępnych lokalizacji zasobów GCP. |
type |
Wskazuje, czy lokalizacja zasobu GCP jest lokalizacją w jednym czy w wielu regionach na potrzeby replikacji danych. |
features[] |
Usługi i usługi dostępne w lokalizacji zasobów GCP. |
LocationType
Określa sposób replikacji danych w lokalizacji zasobu GCP. Dowiedz się więcej o typach lokalizacji zasobów GCP.
Wartości w polu enum | |
---|---|
LOCATION_TYPE_UNSPECIFIED |
Jest używany wewnętrznie do rozróżniania wartości nieskonfigurowanych i nie jest przeznaczony do użytku zewnętrznego. |
REGIONAL |
Lokalizacja jest lokalizacją regionalną. Dane w lokalizacji regionalnej są replikowane w wielu strefach w regionie. |
MULTI_REGIONAL |
Lokalizacja obejmuje wiele regionów. Dane w lokalizacji obejmującej wiele regionów są replikowane w wielu regionach. W każdym regionie dane są replikowane w wielu strefach. |
Funkcja lokalizacji
Usługi i usługi dostępne w lokalizacji zasobów GCP.
Wartości w polu enum | |
---|---|
LOCATION_FEATURE_UNSPECIFIED |
Jest używany wewnętrznie do rozróżniania wartości nieskonfigurowanych i nie jest przeznaczony do użytku zewnętrznego. |
FIRESTORE |
Ta lokalizacja obsługuje instancje bazy danych Cloud Firestore. W tej lokalizacji dostępna jest usługa App Engine, więc może to być domyślna lokalizacja zasobów GCP projektu. |
DEFAULT_STORAGE |
Ta lokalizacja obsługuje domyślne zasobniki Cloud Storage. W tej lokalizacji dostępna jest usługa App Engine, więc może to być domyślna lokalizacja zasobów GCP projektu. |
FUNCTIONS |
W tej lokalizacji jest dostępna usługa Cloud Functions dla Firebase. |