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.
DescribeSnapshots
Renvoie des informations sur les instantanés de cluster. Par défaut, DescribeSnapshots répertorie tous vos instantanés ; il peut éventuellement décrire un seul instantané ou uniquement les instantanés associés à un cluster particulier.
Syntaxe de la requête
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowDetail": boolean,
"SnapshotName": "string",
"Source": "string"
}Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
Cette demande accepte les données suivantes au format JSON.
- ClusterName
-
Un identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, seuls les instantanés associés à ce cluster spécifique sont décrits.
Type : chaîne
Obligatoire : non
- MaxResults
-
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la MaxResults valeur spécifiée, un jeton est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Type : Integer
Obligatoire : non
- NextToken
-
Argument facultatif à transmettre si le nombre total d'enregistrements dépasse la valeur de MaxResults. Si NextToken est renvoyé, d'autres résultats sont disponibles. La valeur de NextToken est un jeton de pagination unique pour chaque page. Répète l'appel en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés.
Type : chaîne
Obligatoire : non
- ShowDetail
-
Une valeur booléenne qui, si elle est vraie, inclut la configuration de la partition dans la description de l'instantané.
Type : booléen
Obligatoire : non
- SnapshotName
-
Nom de l'instantané fourni par l'utilisateur. Si ce paramètre est spécifié, seul cet instantané nommé est décrit.
Type : chaîne
Obligatoire : non
- Source
-
S'il est réglé sur système, la sortie affiche des instantanés créés automatiquement par MemoryDB. S'il est défini sur utilisateur, la sortie affiche des instantanés créés manuellement. En cas d'omission, la sortie affiche les instantanés créés automatiquement et manuellement.
Type : chaîne
Obligatoire : non
Syntaxe de la réponse
{
"NextToken": "string",
"Snapshots": [
{
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "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
-
Argument facultatif à transmettre si le nombre total d'enregistrements dépasse la valeur de MaxResults. Si NextToken est renvoyé, d'autres résultats sont disponibles. La valeur de NextToken est un jeton de pagination unique pour chaque page. Répète l'appel en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés.
Type : Chaîne
- Snapshots
-
Une liste de clichés. Chaque élément de la liste contient des informations détaillées sur un instantané.
Type : tableau d’objets Snapshot
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Types d'erreurs courants.
- InvalidParameterCombinationException
-
Code d’état HTTP : 400
- InvalidParameterValueException
-
Code d’état HTTP : 400
- ServiceLinkedRoleNotFoundFault
-
Code d’état HTTP : 400
- SnapshotNotFoundFault
-
Code d’état HTTP : 400
Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :
