本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ImportSshPublicKey
向 Transfer Family 用户添加一个由 ServerId
标识、分配给启用文件传输协议的特定服务器(由标识)的值的 Secure Shell (SSH)。向 Transfer Family 用户添加 Secure Shell (SSH) 公有密钥,该用户由指定给启用文件传输协议的特定服务器的 UserName
值标识,该服务器由标识。
响应返回的 UserName
值、ServerId
值和 SshPublicKeyId
名称。
请求语法
{
"ServerId": "string
",
"SshPublicKeyBody": "string
",
"UserName": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅常用参数。
请求接受采用 JSON 格式的以下数据。
- ServerId
-
系统为服务器分配的唯一标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
s-([0-9a-f]{17})
必需:是
- SshPublicKeyBody
-
SSH 密钥对的公有密钥部分。
Amazon Transfer Family 接受 RSA、ECDSA 和 ED25519 密钥。
类型:字符串
长度约束:最小长度为 0。最大长度为 2048。
必需:是
- UserName
-
分配给一台或多台服务器的 Transfer Family 用户的名称。
类型:字符串
长度约束:最小长度为 3。最大长度为 100。
模式:
[\w][\w@.-]{2,99}
必需:是
响应语法
{
"ServerId": "string",
"SshPublicKeyId": "string",
"UserName": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- ServerId
-
系统为服务器分配的唯一标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
s-([0-9a-f]{17})
- SshPublicKeyId
-
导入的系统为公有密钥命名的名称。
类型:字符串
长度限制:固定长度为 21。
模式:
key-[0-9a-f]{17}
- UserName
-
分配给指定
ServerID
值的用户名。类型:字符串
长度约束:最小长度为 3。最大长度为 100。
模式:
[\w][\w@.-]{2,99}
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- InternalServiceError
-
当 Amazon Transfer Family 服务中发生错误时,会引发此异常。
HTTP 状态代码:500
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ResourceExistsException
-
请求的资源不存在,或者存在于为命令指定的区域以外的区域。
HTTP 状态代码:400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时,就会 Amazon引发此异常。
HTTP 状态代码:400
- ServiceUnavailableException
-
请求失败,因为 Trans Amazon fer Family 服务不可用。
HTTP 状态代码:500
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
HTTP 状态代码:400
示例
示例
此命令导入存储在id_ecdsa.pub
文件中的 ECDSA 密钥。
aws transfer import-ssh-public-key --server-id s-021345abcdef6789 --ssh-public-key-body file://id_ecdsa.pub --user-name jane-doe
示例
如果运行上一个命令,系统将返回以下信息。
{ "ServerId": "s-021345abcdef6789", "SshPublicKeyId": "key-1234567890abcdef0", "UserName": "jane-doe" }
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: