Method: projects.locations.backupCollections.list

Listet alle Sicherungssammlungen auf, die einem Verbraucherprojekt entweder am angegebenen Standort (Region) oder an allen Standorten gehören.

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/v1/{parent=projects/*/locations/*}/backupCollections

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

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

Suchparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der Elemente, die zurückgegeben werden sollen.

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

Optional. Der Wert nextPageToken wurde gegebenenfalls von einer vorherigen [backupCollections.list]-Anfrage zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für backupCollections.list.

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

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

object (BackupCollection)

Eine Liste der backupCollections im Projekt.

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-Eintrag für „backupCollection“ eingefügt, wobei das Feld name auf einen Wert der Form projects/{projectId}/locations/{locationId}/backupCollections/- gesetzt wird, das Feld status auf ERROR und das Feld statusMessage auf „location not available for backupCollections.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 einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.