ListHostKeys - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez 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.

ListHostKeys

Renvoie une liste de clés d'hôte pour le serveur spécifiée par le ServerId paramètre.

Syntaxe de la requête

{
   "MaxResults": number,
   "NextToken": "string",
   "ServerId": "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

Le nombre maximum de clés d'hôte à renvoyer.

Type : entier

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

Obligatoire : non

NextToken

Lorsque d'autres résultats n'ont pas été renvoyés, un NextToken paramètre est renvoyé. Vous pouvez utiliser cette valeur pour un appel ultérieur afin de continuer ListHostKeys à répertorier les résultats.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

Obligatoire : non

ServerId

Identifiant du serveur qui contient les clés d'hôte que vous souhaitez consulter.

Type : String

Contraintes de longueur : longueur fixe de 19.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "HostKeys": [ 
      { 
         "Arn": "string",
         "DateImported": number,
         "Description": "string",
         "Fingerprint": "string",
         "HostKeyId": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string",
   "ServerId": "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 sous JSON forme formatée par le service.

HostKeys

Renvoie un tableau dans lequel chaque élément contient les détails d'une clé d'hôte.

Type : tableau d’objets ListedHostKey

NextToken

Renvoie un jeton que vous pouvez utiliser pour appeler à ListHostKeys nouveau et recevoir des résultats supplémentaires, le cas échéant.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

ServerId

Renvoie l'identifiant du serveur qui contient les clés d'hôte répertoriées.

Type : String

Contraintes de longueur : longueur fixe de 19.

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

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

ResourceNotFoundException

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

HTTPCode de statut : 400

ServiceUnavailableException

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

HTTPCode de statut : 500

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :