ListServers - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere 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.

ListServers

Führt die Server auf, die das Dateiübertragungsprotokoll aktivieren und Ihrem Konto zugeordnet sind. AWS

Anforderungssyntax

{
   "MaxResults": number,
   "NextToken": "string"
}

Anforderungsparameter

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

Die Anfrage akzeptiert die folgenden Daten im Format. JSON

MaxResults

Gibt die Anzahl der Server an, die als Antwort auf die ListServers Abfrage zurückgegeben werden sollen.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.

Erforderlich: Nein

NextToken

Wenn mit dem ListServers Befehl zusätzliche Ergebnisse erzielt werden, wird in der Ausgabe ein NextToken Parameter zurückgegeben. Sie können den NextToken Parameter dann in einem nachfolgenden Befehl übergeben, um weitere Server aufzulisten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

Erforderlich: Nein

Antwortsyntax

{
   "NextToken": "string",
   "Servers": [ 
      { 
         "Arn": "string",
         "Domain": "string",
         "EndpointType": "string",
         "IdentityProviderType": "string",
         "LoggingRole": "string",
         "ServerId": "string",
         "State": "string",
         "UserCount": number
      }
   ]
}

Antwortelemente

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

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

NextToken

Wenn Sie mit dem ListServers Vorgang zusätzliche Ergebnisse erzielen können, wird in der Ausgabe ein NextToken Parameter zurückgegeben. In einem folgenden Befehl können Sie den NextToken Parameter übergeben, um weitere Server aufzulisten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

Servers

Eine Reihe von Servern, die aufgelistet wurden.

Typ: Array von ListedServer-Objekten

Fehler

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

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidNextTokenException

Der übergebene NextToken Parameter ist ungültig.

HTTPStatuscode: 400

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

Beispiele

Beispiel

Das folgende Beispiel listet die Server auf, die in Ihrem vorhanden sind AWS-Konto.

Beachten Sie, dass die NextToken Beispielwerte nicht real sind: Sie sollen angeben, wie der Parameter verwendet wird.

Beispielanforderung

{
   "MaxResults": 1,
   "NextToken": "token-from-previous-API-call"
}

Beispielantwort

{
   "NextToken": "another-token-to-continue-listing",
   "Servers": [
      {
         "Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
         "Domain": "S3",
         "IdentityProviderType": "SERVICE_MANAGED",
         "EndpointType": "PUBLIC",
         "LoggingRole": "arn:aws:iam::111112222222:role/my-role",
         "ServerId": "s-01234567890abcdef",
         "State": "ONLINE",
         "UserCount": 3
      }
   ]
}

Weitere Informationen finden Sie unter:

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