Method: projects.locations.list

Liste les informations relatives aux emplacements disponibles pour ce service.

Cette méthode liste les emplacements en fonction du champ d'application de la ressource fourni dans le champ ListLocationsRequest.name :

  • Emplacements mondiaux : si name est vide, la méthode liste les emplacements publics disponibles pour tous les projets.
  • Emplacements spécifiques au projet : si name suit le format projects/{project}, la méthode liste les emplacements visibles pour ce projet spécifique. Cela inclut les emplacements publics, privés ou spécifiques au projet qui sont activés pour le projet.

Pour les implémentations gRPC et de bibliothèque cliente, le nom de ressource est transmis en tant que champ name. Pour les appels de service directs, le nom de ressource est intégré au chemin de requête en fonction de l'implémentation et de la version du service spécifique.

Requête HTTP

GET https://ces.googleapis.com/v1beta/{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 sur la page AIP-160.
pageSize

integer

Nombre maximal de résultats à renvoyer. Si ce champ n'est pas défini, le service sélectionne une valeur par défaut.
pageToken

string

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

string

Facultatif. N'utilisez pas ce champ, sauf indication contraire explicite. Il est principalement destiné à un usage interne.

Corps de la requête

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

Corps de la réponse

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.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • ces.locations.list

Pour en savoir plus, consultez la documentation IAM.