DescribeDBClusters - Amazon DocumentDB

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.

DescribeDBClusters

Gibt Informationen über bereitgestellte Amazon DocumentDB-Cluster zurück. Dieser API-Vorgang unterstützt die Paginierung. Für bestimmte Verwaltungsfunktionen wie Cluster- und Instance-Lebenszyklusmanagement nutzt Amazon DocumentDB Betriebstechnologie, die mit Amazon RDS und Amazon Neptune gemeinsam genutzt wird. Verwenden Sie den filterName=engine,Values=docdb Filterparameter, um nur Amazon DocumentDB-Cluster zurückzugeben.

Anforderungsparameter

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

DBClusterIdentifier

Die vom Benutzer angegebene Cluster-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen aus dem spezifischen Cluster zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Einschränkungen:

  • Falls angegeben, muss er mit einem vorhandenen übereinstimmenDBClusterIdentifier.

Typ: Zeichenfolge

Erforderlich: Nein

Filter.Filter.N

Ein Filter, der einen oder mehrere zu beschreibende Cluster angibt.

Unterstützte Filter:

  • db-cluster-id- Akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur Informationen zu den Clustern, die durch diese ARNs identifiziert wurden.

Typ: Array von Filter-Objekten

Erforderlich: Nein

Marker

Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

Typ: Zeichenfolge

Erforderlich: Nein

MaxRecords

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

Standard: 100

Einschränkungen: Mindestwert 20, Höchstwert 100.

Typ: Ganzzahl

Erforderlich: Nein

Antwortelemente

Die folgenden Elemente werden vom Dienst zurückgegeben.

DBClusters.DBCluster.N

Eine Liste von Clustern.

Typ: Array von DBCluster-Objekten

Marker

Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

Typ: Zeichenfolge

Fehler

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

DBClusterNotFoundFault

DBClusterIdentifierbezieht sich nicht auf einen vorhandenen Cluster.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

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