Method: projects.locations.clusters.list

Elenca tutti i cluster Redis di proprietà di un progetto nella località (regione) specificata o in tutte le località.

La posizione deve avere il seguente formato:

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

Se locationId è specificato come - (carattere jolly), vengono eseguite query su tutte le regioni disponibili per il progetto e i risultati vengono aggregati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa della località del cluster nel formato: projects/{projectId}/locations/{locationId}, dove locationId si riferisce a una regione Google Cloud.

Parametri di query

Parametri
pageSize

integer

Il numero massimo di elementi da restituire.

Se non specificato, il servizio utilizzerà un valore predefinito di 1000. Indipendentemente dal valore di pageSize, la risposta può includere un elenco parziale e il chiamante deve fare affidamento solo su nextPageToken della risposta per determinare se sono rimasti altri cluster da interrogare.
pageToken

string

Il valore nextPageToken restituito da una precedente richiesta clusters.list, se presente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per clusters.list.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campi
clusters[]

object (Cluster)

Un elenco di cluster Redis nel progetto nella località specificata o in tutte le località.

Se locationId nel campo principale della richiesta è "-", vengono eseguite query su tutte le regioni disponibili per il progetto e i risultati vengono aggregati. Se in una query aggregata di questo tipo una località non è disponibile, nella risposta viene inclusa una voce Redis segnaposto con il campo name impostato su un valore del modulo projects/{projectId}/locations/{locationId}/clusters/, il campo status impostato su ERROR e il campo statusMessage impostato su "location not available for clusters.list".
nextPageToken

string

Token per recuperare la pagina successiva di risultati o vuoto se non sono presenti altri risultati nell'elenco.
unreachable[]

string

Località non raggiungibili.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.