

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# DescribeClusters
<a name="API_DescribeClusters"></a>

Recupera informações sobre todos os clusters provisionados se nenhum identificador de cluster for especificado, ou sobre um cluster específico, se um identificador de cluster for fornecido.

## Sintaxe da solicitação
<a name="API_DescribeClusters_RequestSyntax"></a>

```
{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowShardDetails": boolean
}
```

## Parâmetros da solicitação
<a name="API_DescribeClusters_RequestParameters"></a>

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

A solicitação aceita os dados a seguir no formato JSON.

 ** [ClusterName](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-ClusterName"></a>
O nome do cluster.  
Tipo: string  
Obrigatório: Não

 ** [MaxResults](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-MaxResults"></a>
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o MaxResults valor especificado, um token será incluído na resposta para que os resultados restantes possam ser recuperados.  
Tipo: inteiro  
Obrigatório: não

 ** [NextToken](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-NextToken"></a>
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.   
Tipo: string  
Obrigatório: não

 ** [ShowShardDetails](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-ShowShardDetails"></a>
Um sinalizador opcional que pode ser incluído na solicitação para recuperar informações sobre os fragmentos individuais.  
Tipo: booliano  
Obrigatório: não

## Sintaxe da resposta
<a name="API_DescribeClusters_ResponseSyntax"></a>

```
{
   "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"
}
```

## Elementos de resposta
<a name="API_DescribeClusters_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [Clusters](#API_DescribeClusters_ResponseSyntax) **   <a name="MemoryDB-DescribeClusters-response-Clusters"></a>
Uma lista de clusters  
Tipo: matriz de objetos [Cluster](API_Cluster.md)

 ** [NextToken](#API_DescribeClusters_ResponseSyntax) **   <a name="MemoryDB-DescribeClusters-response-NextToken"></a>
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.   
Tipo: string

## Erros
<a name="API_DescribeClusters_Errors"></a>

Para obter informações sobre os erros comuns que são comuns em todas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ClusterNotFoundFault **   
  
Código de status HTTP: 400

 ** InvalidParameterCombinationException **   
  
Código de status HTTP: 400

 ** InvalidParameterValueException **   
  
Código de status HTTP: 400

 ** ServiceLinkedRoleNotFoundFault **   
  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeClusters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeClusters) 