Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
DescribeClusters
Restituisce informazioni su tutti i cluster assegnati se non viene specificato alcun identificatore di cluster o su un cluster specifico se viene fornito un nome di cluster.
Sintassi della richiesta
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowShardDetails": boolean
}Parametri della richiesta
Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.
La richiesta accetta i seguenti dati in formato JSON.
- ClusterName
-
Il nome del cluster.
▬Tipo: stringa
Obbligatorio: no
- MaxResults
-
Numero massimo di record da includere nella risposta. Se esistono più record rispetto al MaxResults valore specificato, nella risposta viene incluso un token in modo da poter recuperare i risultati rimanenti.
Tipo: Integer
Obbligatorio: no
- NextToken
-
Un argomento opzionale da passare nel caso in cui il numero totale di record superi il valore di. MaxResults Se viene restituito NextToken, sono disponibili più risultati. Il valore di nextToken è un token di paginazione univoco per ogni pagina. Effettua nuovamente la chiamata utilizzando il token restituito per recuperare la pagina successiva. Mantieni invariati tutti gli altri argomenti.
▬Tipo: stringa
Obbligatorio: no
- ShowShardDetails
-
Un flag opzionale che può essere incluso nella richiesta per recuperare informazioni sui singoli frammenti.
Tipo: Booleano
Obbligatorio: no
Sintassi della risposta
{
"Clusters": [
{
"ACLName": "string",
"ARN": "string",
"AutoMinorVersionUpgrade": boolean,
"AvailabilityMode": "string",
"ClusterEndpoint": {
"Address": "string",
"Port": number
},
"DataTiering": "string",
"Description": "string",
"Engine": "string",
"EnginePatchVersion": "string",
"EngineVersion": "string",
"IpDiscovery": "string",
"KmsKeyId": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"Name": "string",
"NetworkType": "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"
}Elementi di risposta
Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.
I dati seguenti vengono restituiti in formato JSON mediante il servizio.
- Clusters
-
Un elenco di cluster
Tipo: matrice di oggetti Cluster
- NextToken
-
Un argomento opzionale da passare nel caso in cui il numero totale di record superi il valore di. MaxResults Se viene restituito NextToken, sono disponibili più risultati. Il valore di nextToken è un token di paginazione univoco per ogni pagina. Effettua nuovamente la chiamata utilizzando il token restituito per recuperare la pagina successiva. Mantieni invariati tutti gli altri argomenti.
Tipo: stringa
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Tipi di errore comuni.
- ClusterNotFoundFault
-
Codice di stato HTTP: 400
- InvalidParameterCombinationException
-
Codice di stato HTTP: 400
- InvalidParameterValueException
-
Codice di stato HTTP: 400
- ServiceLinkedRoleNotFoundFault
-
Codice di stato HTTP: 400
Vedi anche
Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue:
