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.
ImportHostKey
Ajoute une clé d'hôte au serveur spécifiée par le ServerId
paramètre.
Syntaxe de la requête
{
"Description": "string
",
"HostKeyBody": "string
",
"ServerId": "string
",
"Tags": [
{
"Key": "string
",
"Value": "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.
- Description
-
Description textuelle identifiant cette clé d'hôte.
Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 200.
Modèle :
[\p{Print}]*
Obligatoire : non
- HostKeyBody
-
La partie clé privée d'une paire de clés SSH.
AWS Transfer Family accepte les clés RSA, ECDSA et ED25519.
Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 4096.
Obligatoire : oui
- ServerId
-
Identifiant du serveur qui contient la clé d'hôte que vous importez.
Type : chaîne
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})
Obligatoire : oui
- Tags
-
Paires clé-valeur qui peuvent être utilisées pour regrouper et rechercher des clés d'hôte.
Type : tableau d’objets Tag
Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.
Obligatoire : non
Syntaxe de la réponse
{
"HostKeyId": "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 au format JSON par le service.
- HostKeyId
-
Renvoie l'identifiant de clé d'hôte pour la clé importée.
Type : chaîne
Contraintes de longueur : longueur fixe de 25.
Modèle :
hostkey-[0-9a-f]{17}
- ServerId
-
Renvoie l'identifiant du serveur qui contient la clé importée.
Type : chaîne
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.
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
- ResourceExistsException
-
La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.
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
- ThrottlingException
-
La demande a été refusée suite à une limitation des demandes.
Code d’état HTTP : 400
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 :