Method: projects.locations.clusters.list

Listet alle Redis-Cluster auf, die einem Projekt gehören, entweder am angegebenen Standort (Region) oder an allen Standorten.

Der Speicherort sollte das folgende Format haben:

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

Wenn locationId als - (Platzhalter) angegeben wird, werden alle für das Projekt verfügbaren Regionen abgefragt und die Ergebnisse werden zusammengefasst.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Clusterstandorts im Format projects/{projectId}/locations/{locationId}, wobei locationId auf eine Google Cloud-Region verweist.

Suchparameter

Parameter
pageSize

integer

Die maximale Anzahl der Elemente, die zurückzugeben sind.

Wenn nicht angegeben, wird vom Dienst der Standardwert 1.000 verwendet. Unabhängig vom Wert von „pageSize“ kann die Antwort eine Teilliste enthalten. Der Aufrufer sollte sich nur auf nextPageToken in der Antwort verlassen, um festzustellen, ob weitere Cluster abgefragt werden müssen.
pageToken

string

Der Wert nextPageToken wurde gegebenenfalls von einer vorherigen clusters.list-Anfrage zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für clusters.list.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Felder
clusters[]

object (Cluster)

Eine Liste der Redis-Cluster im Projekt am angegebenen Standort oder an allen Standorten.

Wenn locationId im übergeordneten Feld der Anfrage „-“ ist, werden alle für das Projekt verfügbaren Regionen abgefragt und die Ergebnisse zusammengefasst. Wenn in einer solchen aggregierten Anfrage ein Standort nicht verfügbar ist, wird in die Antwort ein Platzhalter-Redis-Eintrag aufgenommen, bei dem das Feld name auf einen Wert der Form projects/{projectId}/locations/{locationId}/clusters/- und das Feld status auf ERROR und das Feld statusMessage auf „location not available for clusters.list“ (Standort für clusters.list nicht verfügbar) festgelegt ist.
nextPageToken

string

Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind.
unreachable[]

string

Standorte, die nicht erreicht werden konnten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.