DescribeClusters - Amazon MemoryDB
請求語法請求參數回應語法回應元素錯誤另請參閱

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

DescribeClusters

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

請求語法

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

請求參數

如需所有動作的一般參數資訊，請參閱《Common Parameters》。

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

ClusterName

叢集的名稱。

類型：字串

必要：否

MaxResults

要在回應中包含的記錄數量上限。如果存在的記錄超過指定的 MaxResults 值，則會在回應中包含權杖，以便擷取剩餘的結果。

類型：整數

必要：否

NextToken

如果記錄總數超過 MaxResults 的值，要傳遞的選用引數。如果傳回 nextToken，則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。

類型：字串

必要：否

ShowShardDetails

選用的旗標，可以包含在擷取個別碎片 (s) 相關資訊的請求中。

類型：布林值

必要：否

回應語法

{
   "Clusters": [ 
      { 
         "ACLName": "string",
         "ARN": "string",
         "AutoMinorVersionUpgrade": boolean,
         "AvailabilityMode": "string",
         "ClusterEndpoint": { 
            "Address": "string",
            "Port": number
         },
         "DataTiering": "string",
         "Description": "string",
         "Engine": "string",
         "EnginePatchVersion": "string",
         "EngineVersion": "string",
         "KmsKeyId": "string",
         "MaintenanceWindow": "string",
         "MultiRegionClusterName": "string",
         "Name": "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

另請參閱

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：