Methode: projects.locations.instances.list

Listet alle Redis-Instanzen auf, die einem Projekt entweder in dem angegebenen Standort (Region) oder in allen Standorten zugehörig sind.

Der Standort muss das folgende Format haben: * projects/{projectId}/locations/{locationId}

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

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Instanzstandorts im Format projects/{projectId}/locations/{locationId}, wobei sich locationId auf eine GPC-Region bezieht.

Suchparameter

Parameter
pageSize

number

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

Wenn nicht angegeben, wird vom Dienst der Standardwert 1.000 verwendet. Unabhängig vom pageSize-Wert kann die Antwort eine unvollständige Liste enthalten. Aufrufer sollten sich nur auf die Antwort [nextPageToken][CloudRedis.ListInstancesResponse.next_page_token] verlassen, um zu bestimmen, ob weitere Instanzen abgefragt werden können.
pageToken

string

Der Wert "nextPageToken" wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Antwort für instances.list.

JSON-Darstellung 

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

object(Instance)

Eine Liste der Redis-Instanzen im Projekt in dem angegebenen Standort oder in allen Standorten.

Wenn die 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 zusammengefassten Abfrage eine Zone nicht verfügbar ist, wird der Antwort ein Redis-Eintrag als Dummy hinzugefügt. Das Feld "name" erhält hierbei einen Wert im Format "projects/{projectId}/locations/{locationId}/instances/-", das Feld "status" den Wert ERROR und das Feld "statusMessage" den Wert "location not available for instances.list".
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 den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.