本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ImportHostKey
將主機金鑰新增至ServerId
參數所指定的伺服器。
請求語法
{
"Description": "string
",
"HostKeyBody": "string
",
"ServerId": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- Description
-
識別此主機金鑰的文字描述。
類型:字串
長度限制:長度下限為 0。長度上限為 200。
模式:
[\p{Print}]*
必要:否
- HostKeyBody
-
SSH key pair 的私密金鑰部分。
AWS Transfer Family 接受 RSA、ECDSA 和 ED25519 金鑰。
類型:字串
長度限制:長度下限為 0。長度上限為 4096。
必要:是
- ServerId
-
包含要匯入之主機金鑰之伺服器的識別碼。
類型:字串
長度約束:固定長度為 19。
模式:
s-([0-9a-f]{17})
必要:是
- Tags
-
可用於分組和搜尋主機金鑰的索引鍵值配對。
類型:Tag 物件陣列
陣列成員:項目數下限為 1。項目數上限為 50。
必要:否
回應語法
{
"HostKeyId": "string",
"ServerId": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InternalServiceError
-
當在 AWS Transfer Family 服務中發生錯誤時,拋出此異常。
HTTP 狀態碼:500
- InvalidRequestException
-
當客戶端提交格式錯誤的請求時,拋出此異常。
HTTP 狀態碼:400
- ResourceExistsException
-
請求的資源不存在,或者存在於為命令指定的區域以外的區域中。
HTTP 狀態碼:400
- ResourceNotFoundException
-
當 AWS Transfer Family 服務找不到資源時,會擲回此例外狀況。
HTTP 狀態碼:400
- ServiceUnavailableException
-
申請失敗,因為 AWS Transfer Family 服務不可用。
HTTP 狀態碼:500
- ThrottlingException
-
由於請求調節,因此請求遭到拒絕。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: