Method: projects.availableLocations.list

Répertorie les emplacements de ressources Google Cloud Platform (GCP) valides pour le projet spécifié (y compris un FirebaseProject ).

L'un de ces emplacements peut être sélectionné comme emplacement des ressources GCP par défaut du projet, qui est l'emplacement géographique où les ressources du projet, telles que Cloud Firestore, seront provisionnées par défaut. Toutefois, si l'emplacement des ressources GCP par défaut a déjà été défini pour le projet, ce paramètre ne peut pas être modifié.

Cet appel vérifie les éventuelles restrictions d'emplacement pour le projet spécifié et peut donc renvoyer un sous-ensemble de tous les emplacements de ressources GCP possibles. Pour répertorier tous les emplacements de ressources GCP (quelles que soient les restrictions), appelez le point de terminaison sans spécifier d'identifiant de projet unique (c'est-à-dire /v1beta1/{parent=projects/-}/listAvailableLocations ).

Pour appeler availableLocations.list avec un projet spécifié, un membre doit être au minimum un spectateur du projet. Les appels sans projet spécifié ne nécessitent aucune autorisation de projet spécifique.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Le FirebaseProject pour lequel répertorier les emplacements des ressources GCP, au format :

projects/ PROJECT_IDENTIFIER

Reportez-vous au champ name FirebaseProject pour plus de détails sur les valeurs PROJECT_IDENTIFIER .

Si aucun identifiant de projet unique n'est spécifié (c'est-à-dire, projects/- ), la liste renvoyée ne prend pas en compte les restrictions d'emplacement spécifiques à l'organisation ou au projet.

Paramètres de requête

Paramètres
pageToken

string

Jeton renvoyé lors d'un appel précédent à availableLocations.list indiquant l'emplacement dans la liste des emplacements pour reprendre la liste.

pageSize

integer

Nombre maximum d'emplacements à renvoyer dans la réponse.

Le serveur peut renvoyer une valeur inférieure à cette valeur à sa discrétion. Si aucune valeur n'est spécifiée (ou si une valeur trop grande est spécifiée), alors le serveur imposera sa propre limite.

Cette valeur ne peut pas être négative.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Représentation JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Des champs
locations[]

object ( Location )

Une page de résultats d'un appel à availableLocations.list .

nextPageToken

string

Si la liste de résultats est trop longue pour tenir dans une seule réponse, un jeton est renvoyé. Si la chaîne est vide, alors cette réponse constitue la dernière page de résultats et tous les emplacements disponibles ont été répertoriés.

Ce jeton peut être utilisé lors d’un appel ultérieur à availableLocations.list pour trouver plus d’emplacements.

Les jetons de page sont de courte durée et ne doivent pas être conservés.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

  • 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

Pour plus d'informations, consultez la Présentation de l'authentification .

Emplacement

Emplacement de ressource GCP qui peut être sélectionné pour un FirebaseProject .

Représentation JSON
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Des champs
locationId

string

ID de l'emplacement de la ressource GCP. Ce sera l'un des emplacements de ressources GCP disponibles.

type

enum ( LocationType )

Indique si l'emplacement de la ressource GCP est un emplacement régional ou multirégional pour la réplication des données.

features[]

enum ( LocationFeature )

Produits et services disponibles à l'emplacement des ressources GCP.

Type de lieu

Spécifie la manière dont les données sont répliquées dans l'emplacement des ressources GCP. En savoir plus sur les types d'emplacements de ressources GCP .

Énumérations
LOCATION_TYPE_UNSPECIFIED Utilisé en interne pour distinguer les valeurs non définies et n'est pas destiné à un usage externe.
REGIONAL

L'emplacement est un emplacement régional.

Les données d'un emplacement régional sont répliquées dans plusieurs zones d'une région.

MULTI_REGIONAL

L'emplacement est un emplacement multirégional.

Les données situées dans un emplacement multirégional sont répliquées dans plusieurs régions. Au sein de chaque région, les données sont répliquées dans plusieurs zones.

EmplacementFonctionnalité

Produits et services disponibles à l'emplacement des ressources GCP.

Énumérations
LOCATION_FEATURE_UNSPECIFIED Utilisé en interne pour distinguer les valeurs non définies et n'est pas destiné à un usage externe.
FIRESTORE

Cet emplacement prend en charge les instances de base de données Cloud Firestore.

App Engine est disponible à cet emplacement. Il peut donc s'agir de l'emplacement des ressources GCP par défaut d'un projet.

DEFAULT_STORAGE

Cet emplacement prend en charge les buckets Cloud Storage par défaut.

App Engine est disponible à cet emplacement. Il peut donc s'agir de l'emplacement des ressources GCP par défaut d'un projet.

FUNCTIONS Cloud Functions pour Firebase est disponible à cet emplacement.