DescribeDBInstances - 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.

DescribeDBInstances

Gibt Informationen über bereitgestellte Amazon DocumentDB DocumentDB-Instances zurück. Diese API unterstützt Paginierung.

Anforderungsparameter

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

DBInstanceIdentifier

Die vom Benutzer angegebene Instance-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen von der jeweiligen Instanz zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Einschränkungen:

  • Falls angegeben, muss er mit dem Bezeichner einer vorhandenen übereinstimmenDBInstance.

Typ: Zeichenfolge

Erforderlich: Nein

Filter.Filter.N

Ein Filter, der eine oder mehrere zu beschreibende Instanzen angibt.

Unterstützte Filter:

  • db-cluster-id- Akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur die Informationen über die Instances, die den Clustern zugeordnet sind, die durch diese ARNs identifiziert werden.

  • db-instance-id- Akzeptiert Instanzkennungen und Instanz-ARNs. Die Ergebnisliste enthält nur die Informationen zu den Instances, die durch diese ARNs identifiziert werden.

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.

DBInstances.DbInstance.

Detaillierte Informationen zu einer oder mehreren Instanzen.

Typ: Array von DBInstance-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.

DBInstanceNotFound

DBInstanceIdentifierbezieht sich nicht auf eine bestehende Instanz.

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: