DescribeClusters - Amazon MemoryDB
请求语法请求参数响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

DescribeClusters

如果未指定集群标识符，则返回所有已设置集群的有关信息；如果提供了集群名称，则返回特定集群的有关信息。

请求语法

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

请求参数

有关所有操作的通用参数的信息，请参阅常用参数。

请求接受采用 JSON 格式的以下数据。

ClusterName

集群的名称。

类型：字符串

必需：否

MaxResults

包括在响应中的最大记录数。如果存在的记录多于指定 MaxResults 值，则响应中会包含一个标记，以便可以检索剩余的结果。

类型：整数

必需：否

NextToken

一个可选参数，用于在记录总数超过的值时传递 MaxResults。如果返回 nextToken，则会有更多可用结果。nextToken 的值是每个页面的唯一分页令牌。使用返回的令牌再次调用以检索下一页。保留所有其他参数不变。

类型：字符串

必需：否

ShowShardDetails

可包含在请求中、以用于检索有关单个分片信息的可选标志。

类型：布尔值

必需：否

响应语法

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

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

Clusters

集群列表

类型：Cluster 对象数组

NextToken

一个可选参数，用于在记录总数超过的值时传递 MaxResults。如果返回 nextToken，则会有更多可用结果。nextToken 的值是每个页面的唯一分页令牌。使用返回的令牌再次调用以检索下一页。保留所有其他参数不变。

类型：字符串

错误

有关所有操作的常见错误的信息，请参阅常见错误。

ClusterNotFoundFault

HTTP 状态代码：400

InvalidParameterCombinationException

HTTP 状态代码：400

InvalidParameterValueException

HTTP 状态代码：400

ServiceLinkedRoleNotFoundFault

HTTP 状态代码：400

另请参阅

有关以特定语言之一使用此 API 的更多信息 Amazon SDKs，请参阅以下内容：