Method: projects.locations.clusters.list

Répertorie tous les clusters Redis appartenant à un projet, dans la région spécifiée ou dans toutes les régions.

L'emplacement doit respecter le format suivant :

  • projects/{projectId}/locations/{locationId}

Si locationId est défini sur - (masque générique), toutes les régions disponibles pour le projet sont interrogées et les résultats sont agrégés.

Requête HTTP

GET https://redis.googleapis.com/v1/{parent=projects/*/locations/*}/clusters

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'emplacement du cluster au format projects/{projectId}/locations/{locationId}, où locationId fait référence à une région Google Cloud.

Paramètres de requête

Paramètres
pageSize

integer

Le nombre maximum d'éléments à afficher.

Si aucune valeur n'est spécifiée, une valeur par défaut de 1 000 est utilisée par le service. Quelle que soit la valeur pageSize, la réponse peut inclure une liste partielle et un appelant ne doit s'appuyer que sur le nextPageToken de la réponse pour déterminer s'il reste d'autres clusters à interroger.
pageToken

string

La valeur nextPageToken renvoyée par une requête [clusters.list][CloudRedis.ListClusters] précédente, le cas échéant.

Corps de la requête

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

Corps de la réponse

Réponse pour [clusters.list][CloudRedis.ListClusters].

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

Représentation JSON 
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
clusters[]

object (Cluster)

Liste des clusters Redis dans le projet à l'emplacement spécifié ou à tous les emplacements.

Si la valeur locationId dans le champ parent de la requête est "-", toutes les régions disponibles pour le projet sont interrogées et les résultats agrégés. Si, dans une telle requête agrégée, une zone géographique n'est pas disponible, une entrée Redis de substitution est incluse dans la réponse avec le champ name défini sur une valeur de la forme projects/{projectId}/locations/{locationId}/clusters/, le champ status défini sur ERROR et le champ statusMessage défini sur "location not available for clusters.list".
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.
unreachable[]

string

Emplacements inaccessibles.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.