Méthode : projects.locations.instances.list

Répertorie toutes les instances Redis associées à un projet à l'emplacement spécifié (région) ou à tous les emplacements.

L'emplacement doit avoir le format suivant : * projects/{projectId}/locations/{locationId}.

Si le champ locationId est spécifié en tant que - (caractère 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/*}/instances

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin

Paramètres
parent

string

Obligatoire. Nom de la ressource de l'emplacement de l'instance au format suivant : projects/{projectId}/locations/{locationId}, où locationId correspond à une région GCP.

Paramètres de requête

Paramètres
pageSize

number

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. Indépendamment de la valeur pageSize, la réponse peut inclure une liste partielle, et un appelant ne doit se baser que sur la réponse de [nextPageToken] [CloudRedis.ListInstancesResponse.next_page_token] pour déterminer s'il reste d'autres instances à interroger.
pageToken

string

La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant.

Corps de la requête

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

Corps de la réponse

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

Réponse pour instances.list.

Représentation JSON 

{
  "instances": [
    {
      object(Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
instances[]

objet ( Instance )

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

Si locationId dans le champ parent de la requête correspond à "-", toutes les régions disponibles pour le projet sont interrogées, et les résultats sont agrégés. Si, dans une telle requête agrégée, un emplacement est indisponible, une entrée Redis test est incluse dans la réponse avec le champ "name" défini sur une valeur au format projects/{projectId}/locations/{locationId}/instances/- et le champ "status" est défini sur ERROR. Enfin, le champ "statusMessage" est défini sur "emplacement non disponible pour instances.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.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.