ListClusterSnapshots - Amazon DocumentDB
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListClusterSnapshots

Renvoie des informations sur les instantanés d'un cluster élastique spécifié.

Syntaxe de la demande

GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

clusterArn

L'identifiant ARN du cluster élastique.

maxResults

Le nombre maximal de résultats de capture instantanée du cluster élastique à recevoir dans la réponse.

Plage valide : valeur minimale de 20. Valeur maximale fixée à 100.

nextToken

Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée parmax-results.

S'il n'y a plus de données dans la réponse, elles ne nextToken seront pas renvoyées.

snapshotType

Type de snapshots de cluster à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :

  • automated- Renvoie tous les instantanés de cluster qu'Amazon DocumentDB a automatiquement créés pour AWS votre compte.

  • manual- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre AWS compte.

Corps de la requête

La demande n’a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

nextToken

Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée parmax-results.

S'il n'y a plus de données dans la réponse, elles ne nextToken seront pas renvoyées.

Type : String

snapshots

Liste des instantanés pour un cluster élastique spécifié.

Type : tableau d’objets ClusterSnapshotInList

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.

Code d’état HTTP : 403

InternalServerException

Une erreur interne du serveur s'est produite.

Code d’état HTTP : 500

ThrottlingException

ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.

Code d’état HTTP : 429

ValidationException

Structure définissant une exception de validation.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :