Method: projects.locations.backupCollections.list

Répertorie toutes les collections de sauvegardes appartenant à un projet grand public à l'emplacement (région) spécifié ou à tous les emplacements.

Si locationId est spécifié comme - (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://memorystore.googleapis.com/v1alpha/{parent=projects/*/locations/*}/backupCollections

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource de l'emplacement de backupCollection au format projects/{projectId}/locations/{locationId}, où locationId fait référence à une région Google Cloud.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Le nombre maximum d'éléments à renvoyer.

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 s'appuyer que sur le nextPageToken de la réponse pour déterminer s'il reste d'autres clusters à interroger.
pageToken

string

Facultatif. Valeur nextPageToken renvoyée par une requête [backupCollections.list] précédente, le cas échéant.

Corps de la requête

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

Corps de la réponse

Réponse pour [backupCollections.list].

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

Représentation JSON 
{
  "backupCollections": [
    {
      object (BackupCollection)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
backupCollections[]

object (BackupCollection)

Liste des backupCollections du projet.

Si la valeur locationId dans le champ parent de la requête est "-", toutes les régions disponibles pour le projet sont interrogées et les résultats agrégés. Si, dans une telle requête agrégée, un emplacement n'est pas disponible, une entrée d'espace réservé backupCollection est incluse dans la réponse, le champ name étant défini sur une valeur du type projects/{projectId}/locations/{locationId}/backupCollections/-, le champ status sur ERROR et le champ statusMessage sur "emplacement non disponible pour backupCollections.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 niveau d'accès OAuth suivant :

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

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • memorystore.backupCollections.list

Pour en savoir plus, consultez la documentation IAM.