Method: projects.availableLocations.list

Listet die gültigen Ressourcenstandorte der Google Cloud Platform (GCP) für das angegebene Projekt auf (einschließlich eines FirebaseProject ).

Einer dieser Standorte kann als standardmäßiger GCP-Ressourcenstandort des Projekts ausgewählt werden. Dabei handelt es sich um den geografischen Standort, an dem die Ressourcen des Projekts, z. B. Cloud Firestore, standardmäßig bereitgestellt werden. Wenn jedoch bereits der standardmäßige GCP-Ressourcenstandort für das Projekt festgelegt wurde, kann diese Einstellung nicht geändert werden.

Dieser Aufruf prüft auf mögliche Standortbeschränkungen für das angegebene Projekt und gibt daher möglicherweise eine Teilmenge aller möglichen GCP-Ressourcenstandorte zurück. Um alle GCP-Ressourcenstandorte aufzulisten (unabhängig von etwaigen Einschränkungen), rufen Sie den Endpunkt auf, ohne eine eindeutige Projektkennung anzugeben (d. /v1beta1/{parent=projects/-}/listAvailableLocations ).

Um availableLocations.list mit einem angegebenen Projekt aufzurufen, muss ein Mitglied mindestens ein Betrachter des Projekts sein. Für Aufrufe ohne angegebenes Projekt sind keine spezifischen Projektberechtigungen erforderlich.

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
parent

string

Das FirebaseProject , für das GCP-Ressourcenstandorte aufgelistet werden sollen, im Format:

projects/ PROJECT_IDENTIFIER

Einzelheiten zu PROJECT_IDENTIFIER Werten finden Sie im name FirebaseProject .

Wenn keine eindeutige Projektkennung angegeben ist (d. h. „ projects/- “), berücksichtigt die zurückgegebene Liste keine organisationsspezifischen oder projektspezifischen Standortbeschränkungen.

Abfrageparameter

Parameter
pageToken

string

Von einem vorherigen Aufruf von availableLocations.list zurückgegebenes Token, das angibt, wo in der Liste der Standorte die Auflistung fortgesetzt werden soll.

pageSize

integer

Die maximale Anzahl von Standorten, die in der Antwort zurückgegeben werden sollen.

Der Server kann nach eigenem Ermessen weniger als diesen Wert zurückgeben. Wenn kein Wert angegeben wird (oder ein zu großer Wert angegeben wird), legt der Server sein eigenes Limit fest.

Dieser Wert darf nicht negativ sein.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Felder
locations[]

object ( Location )

Eine Seite mit Ergebnissen eines Aufrufs von availableLocations.list .

nextPageToken

string

Wenn die Ergebnisliste zu groß ist, um in eine einzelne Antwort zu passen, wird ein Token zurückgegeben. Wenn die Zeichenfolge leer ist, handelt es sich bei dieser Antwort um die letzte Ergebnisseite und alle verfügbaren Standorte wurden aufgelistet.

Dieses Token kann in einem nachfolgenden Aufruf von availableLocations.list verwendet werden, um weitere Standorte zu finden.

Seitentokens sind von kurzer Dauer und sollten nicht beibehalten werden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

Standort

Ein GCP-Ressourcenstandort, der für ein FirebaseProject ausgewählt werden kann.

JSON-Darstellung
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Felder
locationId

string

Die ID des GCP-Ressourcenstandorts. Es wird einer der verfügbaren GCP-Ressourcenstandorte sein.

type

enum ( LocationType )

Gibt an, ob der GCP-Ressourcenstandort ein regionaler oder multiregionaler Standort für die Datenreplikation ist.

features[]

enum ( LocationFeature )

Produkte und Dienste, die am GCP-Ressourcenstandort verfügbar sind.

Standorttyp

Gibt an, wie Daten innerhalb des GCP-Ressourcenstandorts repliziert werden. Erfahren Sie mehr über die Arten von GCP-Ressourcenstandorten .

Aufzählungen
LOCATION_TYPE_UNSPECIFIED Wird intern zur Unterscheidung nicht gesetzter Werte verwendet und ist nicht für den externen Gebrauch bestimmt.
REGIONAL

Der Standort ist ein regionaler Standort.

Daten an einem regionalen Standort werden in mehreren Zonen innerhalb einer Region repliziert.

MULTI_REGIONAL

Der Standort ist ein überregionaler Standort.

Daten an einem Standort mit mehreren Regionen werden in mehreren Regionen repliziert. Innerhalb jeder Region werden Daten in mehreren Zonen repliziert.

Standortfunktion

Produkte und Dienste, die am GCP-Ressourcenstandort verfügbar sind.

Aufzählungen
LOCATION_FEATURE_UNSPECIFIED Wird intern zur Unterscheidung nicht gesetzter Werte verwendet und ist nicht für den externen Gebrauch bestimmt.
FIRESTORE

Dieser Standort unterstützt Cloud Firestore-Datenbankinstanzen.

App Engine ist an diesem Standort verfügbar, daher kann es sich um den standardmäßigen GCP-Ressourcenstandort eines Projekts handeln.

DEFAULT_STORAGE

Dieser Standort unterstützt standardmäßige Cloud Storage-Buckets.

App Engine ist an diesem Standort verfügbar, daher kann es sich um den standardmäßigen GCP-Ressourcenstandort eines Projekts handeln.

FUNCTIONS Cloud Functions für Firebase ist an diesem Standort verfügbar.