本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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>

有关所有操作的通用参数的信息，请参阅[常用参数](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeClusters) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeClusters) 
+  [AWS Python 软件开发工具包](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)