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 du 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.
La demande accepte les données suivantes au JSON format suivant.
- ClusterName
-
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 : entier
Obligatoire : non
- NextToken
-
Argument facultatif à transmettre si le nombre total d'enregistrements dépasse la valeur de MaxResults. S'il nextToken est renvoyé, d'autres résultats sont disponibles. La valeur de nextToken est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau 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, indique la configuration de la partition dans la description de l'instantané.
Type : booléen
Obligatoire : non
- SnapshotName
-
Nom du cliché fourni par l'utilisateur. Si ce paramètre est spécifié, seul cet instantané nommé est décrit.
Type : chaîne
Obligatoire : non
- Source
-
Si ce paramètre est défini sur system, la sortie affiche les instantanés créés automatiquement par MemoryDB. Si ce paramètre 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",
"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 sous JSON forme formatée par le service.
- NextToken
-
Argument facultatif à transmettre si le nombre total d'enregistrements dépasse la valeur de MaxResults. S'il nextToken est renvoyé, d'autres résultats sont disponibles. La valeur de nextToken est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés.
Type : String
- Snapshots
-
Une liste d'instantané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 Erreurs courantes.
- InvalidParameterCombinationException
-
HTTPCode de statut : 400
- InvalidParameterValueException
-
HTTPCode de statut : 400
- ServiceLinkedRoleNotFoundFault
-
HTTPCode de statut : 400
- SnapshotNotFoundFault
-
HTTPCode de statut : 400
consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
