Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
ListServers
Répertorie les serveurs compatibles avec le protocole de transfert de fichiers associés à votre compte. AWS
Syntaxe de la requête
{
"MaxResults": number
,
"NextToken": "string
"
}
Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
La demande accepte les données suivantes au JSON format suivant.
- MaxResults
-
Spécifie le nombre de serveurs à renvoyer en réponse à la
ListServers
requête.Type : entier
Plage valide : valeur minimum de 1. La valeur maximale est 1 000.
Obligatoire : non
- NextToken
-
Lorsque des résultats supplémentaires sont obtenus à partir de la
ListServers
commande, unNextToken
paramètre est renvoyé dans la sortie. Vous pouvez ensuite transmettre leNextToken
paramètre dans une commande suivante pour continuer à répertorier les serveurs supplémentaires.Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.
Obligatoire : non
Syntaxe de la réponse
{
"NextToken": "string",
"Servers": [
{
"Arn": "string",
"Domain": "string",
"EndpointType": "string",
"IdentityProviderType": "string",
"LoggingRole": "string",
"ServerId": "string",
"State": "string",
"UserCount": number
}
]
}
Eléments de réponse
Si l'action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées sous JSON forme formatée par le service.
- NextToken
-
Lorsque vous pouvez obtenir des résultats supplémentaires à partir de l'
ListServers
opération, unNextToken
paramètre est renvoyé dans la sortie. Dans une commande suivante, vous pouvez transmettre leNextToken
paramètre pour continuer à répertorier les serveurs supplémentaires.Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.
- Servers
-
Un ensemble de serveurs répertoriés.
Type : tableau d’objets ListedServer
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InternalServiceError
-
Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.
HTTPCode de statut : 500
- InvalidNextTokenException
-
Le
NextToken
paramètre transmis n'est pas valide.HTTPCode de statut : 400
- InvalidRequestException
-
Cette exception est levée lorsque le client soumet une demande mal formée.
HTTPCode de statut : 400
- ServiceUnavailableException
-
La demande a échoué car le service AWS Transfer Family n'est pas disponible.
HTTPCode de statut : 500
Exemples
Exemple
L'exemple suivant répertorie les serveurs qui existent dans votre Compte AWS.
Notez que les NextToken
valeurs d'exemple ne sont pas réelles : elles sont destinées à indiquer comment utiliser le paramètre.
Exemple de demande
{
"MaxResults": 1,
"NextToken": "token-from-previous-API-call"
}
Exemple de réponse
{
"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
}
]
}
consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :