TestConnection - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesconsultez aussi

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.

TestConnection

Teste si votre connecteur SFTP est correctement configuré. Nous vous recommandons vivement d'effectuer cette opération pour tester votre capacité à transférer des fichiers entre le AWS stockage local et le serveur SFTP d'un partenaire commercial.

Syntaxe de la requête

{
   "ConnectorId": "string"
}

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

ConnectorId

Identifiant unique du connecteur.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : c-([0-9a-f]{17})

Obligatoire : oui

Syntaxe de la réponse

{
   "ConnectorId": "string",
   "Status": "string",
   "StatusMessage": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

ConnectorId

Renvoie l'identifiant de l'objet connecteur que vous testez.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : c-([0-9a-f]{17})

Status

Retourne OK en cas de réussite du test ou en ERROR cas d'échec du test.

Type : chaîne

StatusMessage

Renvoie Connection succeeded si le test est réussi. Ou renvoie un message d'erreur descriptif en cas d'échec du test. La liste suivante fournit des informations de dépannage, en fonction du message d'erreur que vous recevez.

  • Vérifiez que votre nom secret correspond à celui indiqué dans les autorisations Transfer Role.

  • Vérifiez l'URL du serveur dans la configuration du connecteur et vérifiez que les informations de connexion fonctionnent correctement en dehors du connecteur.

  • Vérifiez que le secret existe et qu'il est correctement formaté.

  • Vérifiez que la clé d'hôte approuvée dans la configuration du connecteur correspond à la ssh-keyscan sortie.

Type : chaîne

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.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

Exemples

Exemple

L'exemple suivant teste la connexion à un serveur distant.

aws transfer test-connection --connector-id c-abcd1234567890fff

Exemple de réponse

En cas de succès, l'appel d'API renvoie les informations suivantes.

{                                                                                                                                                             
    "Status": "OK",                                                                                                                                           
    "StatusMessage": "Connection succeeded"                                                                                                                   
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :