ListServers - AWS Transfer Family
Sintassi della richiestaParametri della richiestaSintassi della rispostaElementi di rispostaErroriEsempiVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

ListServers

Elenca i server abilitati al protocollo di trasferimento file associati all'account AWS .

Sintassi della richiesta

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

Parametri della richiesta

Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.

La richiesta accetta i seguenti dati nel JSON formato.

MaxResults

Speciifica il numero di server da restituire come risposta alla ListServers query.

Tipo: integer

Intervallo valido: valore minimo di 1. Valore massimo pari a 1000.

Campo obbligatorio: no

NextToken

Quando si ottengono risultati aggiuntivi dal ListServers comando, viene restituito un NextToken parametro nell'output. È quindi possibile passare il NextToken parametro in un comando successivo per continuare a elencare server aggiuntivi.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 6144.

Campo obbligatorio: no

Sintassi della risposta

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

Elementi di risposta

Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.

I seguenti dati vengono restituiti in JSON formato dal servizio.

NextToken

Quando è possibile ottenere risultati aggiuntivi dall'ListServersoperazione, viene restituito un NextToken parametro nell'output. In un comando seguente, è possibile passare il NextToken parametro per continuare a elencare server aggiuntivi.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 6144.

Servers

Una serie di server che sono stati elencati.

Tipo: matrice di oggetti ListedServer

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

InternalServiceError

Questa eccezione viene generata quando si verifica un errore nel AWS Transfer Family servizio.

HTTPCodice di stato: 500

InvalidNextTokenException

Il NextToken parametro passato non è valido.

HTTPCodice di stato: 400

InvalidRequestException

Questa eccezione viene generata quando il client invia una richiesta non valida.

HTTPCodice di stato: 400

ServiceUnavailableException

La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.

HTTPCodice di stato: 500

Esempi

Esempio

L'esempio seguente elenca i server presenti nel tuo Account AWS.

Nota che i NextToken valori di esempio non sono reali: hanno lo scopo di indicare come utilizzare il parametro.

Richiesta di esempio

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

Risposta di esempio

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

Vedi anche

Per ulteriori informazioni sull'utilizzo di questo API parametro in una delle lingue specifiche AWS SDKs, consultate quanto segue: