本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

如果未指定叢集識別符，則傳回所有佈建叢集的相關資訊，如果提供叢集名稱，則傳回特定叢集的相關資訊。

## 請求語法
<a name="API_DescribeClusters_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeClusters_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ClusterName](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-ClusterName"></a>
叢集的名稱。  
類型：字串  
必要：否

 ** [MaxResults](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-MaxResults"></a>
要在回應中包含的記錄數量上限。如果存在的記錄超過指定的 MaxResults 值，則會在回應中包含權杖，以便擷取剩餘的結果。  
類型：整數  
必要：否

 ** [NextToken](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-NextToken"></a>
如果記錄總數超過 MaxResults 的值，要傳遞的選用引數。如果傳回 nextToken，則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。  
類型：字串  
必要：否

 ** [ShowShardDetails](#API_DescribeClusters_RequestSyntax) **   <a name="MemoryDB-DescribeClusters-request-ShowShardDetails"></a>
選用旗標 （可以包含在請求中），以擷取個別碎片的相關資訊。  
類型：布林值  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeClusters_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Clusters](#API_DescribeClusters_ResponseSyntax) **   <a name="MemoryDB-DescribeClusters-response-Clusters"></a>
叢集清單  
類型：[Cluster](API_Cluster.md) 物件陣列

 ** [NextToken](#API_DescribeClusters_ResponseSyntax) **   <a name="MemoryDB-DescribeClusters-response-NextToken"></a>
如果記錄總數超過 MaxResults 的值，要傳遞的選用引數。如果傳回 nextToken，則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。  
類型：字串

## 錯誤
<a name="API_DescribeClusters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClusterNotFoundFault **   
  
HTTP 狀態碼：400

 ** InvalidParameterCombinationException **   
  
HTTP 狀態碼：400

 ** InvalidParameterValueException **   
  
HTTP 狀態碼：400

 ** ServiceLinkedRoleNotFoundFault **   
  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeClusters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeClusters)