ListClusters - Amazon DocumentDB
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere 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.

ListClusters

Gibt Informationen über bereitgestellte elastische Amazon DocumentDB-Cluster zurück.

Anforderungssyntax

GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

maxResults

Die maximale Anzahl von Elastic Cluster-Snapshot-Ergebnissen, die in der Antwort empfangen werden sollen.

Gültiger Bereich: Mindestwert 1. Maximalwert 100.

nextToken

Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von max-results angegebenen Wert.

Wenn die Antwort keine weiteren Daten enthält, nextToken werden sie nicht zurückgegeben.

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "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 elastischer Amazon DocumentDB-Cluster.

Typ: Array von ClusterInList-Objekten

nextToken

Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von max-results angegebenen Wert.

Wenn die Antwort keine weiteren Daten enthält, nextToken werden sie nicht zurückgegeben.

Typ: Zeichenfolge

Fehler

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

AccessDeniedException

Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.

message

Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.

HTTP Status Code: 403

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ThrottlingException

ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.

retryAfterSeconds

Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

fieldList

Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.

message

Eine Fehlermeldung, die die Validierungsausnahme beschreibt.

reason

Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von unknownOperation cannotParsefieldValidationFailed,, oderother).

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: