DescribeClusters - Amazon MemoryDB
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeClusters

Gibt Informationen über alle bereitgestellten Cluster zurück, wenn keine Cluster-ID angegeben ist, oder über einen bestimmten Cluster, wenn ein Clustername angegeben wird.

Anforderungssyntax

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

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ClusterName

Der Name des Clusters

Typ: Zeichenfolge

Erforderlich: Nein

MaxResults

Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene MaxResults Wert vorhanden sind, ist ein Token in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

Typ: Ganzzahl

Erforderlich: Nein

NextToken

Ein optionales Argument, das übergeben wird, falls die Gesamtzahl der Datensätze den Wert von überschreitet MaxResults. Wenn nextToken zurückgegeben wird, sind mehr Ergebnisse verfügbar. Der Wert von nextToken ist ein eindeutiges Paginierungstoken für jede Seite. Rufen Sie erneut mit dem zurückgegebenen Token auf, um die nächste Seite abzurufen. Behalten Sie alle anderen Argumente unverändert bei.

Typ: Zeichenfolge

Erforderlich: Nein

ShowShardDetails

Ein optionales Flag, das in die Anfrage aufgenommen werden kann, um Informationen über die einzelnen Shards abzurufen.

Typ: Boolesch

Erforderlich: Nein

Antwortsyntax

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

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Clusters

Eine Liste von Clustern

Typ: Array von Cluster-Objekten

NextToken

Ein optionales Argument, das übergeben wird, falls die Gesamtzahl der Datensätze den Wert von überschreitet MaxResults. Wenn nextToken zurückgegeben wird, sind mehr Ergebnisse verfügbar. Der Wert von nextToken ist ein eindeutiges Paginierungstoken für jede Seite. Rufen Sie erneut mit dem zurückgegebenen Token auf, um die nächste Seite abzurufen. Behalten Sie alle anderen Argumente unverändert bei.

Typ: Zeichenfolge

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

ClusterNotFoundFault

HTTP Status Code: 400

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: