Method: projects.locations.list

Répertorie les informations concernant les emplacements acceptés pour ce service.

Requête HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

La ressource qui possède la collection d'emplacements, le cas échéant.

Paramètres de requête

Paramètres
filter

string

Un filtre permettant de limiter les résultats à un sous-ensemble préféré. Le langage de filtrage accepte des chaînes telles que "displayName=tokyo". Il est décrit plus en détail dans le document AIP-160.

pageSize

integer

Nombre maximal de résultats à renvoyer. Si cette règle n'est pas configurée, le service en sélectionne une par défaut.

pageToken

string

Jeton de page reçu à partir du champ nextPageToken dans la réponse. Envoyez ce jeton pour recevoir la page suivante.

Corps de la requête

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

Corps de la réponse

Le message de réponse pour Locations.ListLocations.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

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

object (Location)

La liste des emplacements correspondant au filtre spécifié dans la requête.

nextPageToken

string

Le jeton de page suivante de la liste standard.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.