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.
DescribeClusters
Renvoie des informations sur tous les clusters provisionnés si aucun identifiant de cluster n'est spécifié, ou sur un cluster spécifique si un nom de cluster est fourni.
Syntaxe de la requête
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowShardDetails": boolean
}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
-
Nom du cluster.
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
- ShowShardDetails
-
Indicateur facultatif qui peut être inclus dans la demande pour récupérer des informations sur les partitions individuelles.
Type : booléen
Obligatoire : non
Syntaxe de la réponse
{
"Clusters": [
{
"ACLName": "string",
"ARN": "string",
"AutoMinorVersionUpgrade": boolean,
"AvailabilityMode": "string",
"ClusterEndpoint": {
"Address": "string",
"Port": number
},
"DataTiering": "string",
"Description": "string",
"Engine": "string",
"EnginePatchVersion": "string",
"EngineVersion": "string",
"KmsKeyId": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"Name": "string",
"NodeType": "string",
"NumberOfShards": number,
"ParameterGroupName": "string",
"ParameterGroupStatus": "string",
"PendingUpdates": {
"ACLs": {
"ACLToApply": "string"
},
"Resharding": {
"SlotMigration": {
"ProgressPercentage": number
}
},
"ServiceUpdates": [
{
"ServiceUpdateName": "string",
"Status": "string"
}
]
},
"SecurityGroups": [
{
"SecurityGroupId": "string",
"Status": "string"
}
],
"Shards": [
{
"Name": "string",
"Nodes": [
{
"AvailabilityZone": "string",
"CreateTime": number,
"Endpoint": {
"Address": "string",
"Port": number
},
"Name": "string",
"Status": "string"
}
],
"NumberOfNodes": number,
"Slots": "string",
"Status": "string"
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SnsTopicArn": "string",
"SnsTopicStatus": "string",
"Status": "string",
"SubnetGroupName": "string",
"TLSEnabled": boolean
}
],
"NextToken": "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.
- Clusters
-
Une liste de clusters
Type : tableau d’objets Cluster
- 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
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- ClusterNotFoundFault
-
HTTPCode de statut : 400
- InvalidParameterCombinationException
-
HTTPCode de statut : 400
- InvalidParameterValueException
-
HTTPCode de statut : 400
- ServiceLinkedRoleNotFoundFault
-
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 :
