ImportSshPublicKey - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ImportSshPublicKey

將安全殼層 (SSH) 公開金鑰新增至 Transfer Family 使用者,該使用者可透過指派給已啟用特定檔案傳輸通訊協定的伺服器 (以識別) 來識別。UserName ServerId

回應會UserName傳回的ServerId值、值和名稱SshPublicKeyId

請求語法

{ "ServerId": "string", "SshPublicKeyBody": "string", "UserName": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受採用 JSON 格式的下列資料。

ServerId

系統指派給伺服器的唯一識別碼。

類型:字串

長度約束:固定長度為 19。

模式:s-([0-9a-f]{17})

必要:是

SshPublicKeyBody

SSH key pair 的公開金鑰部分。

AWS 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

當在 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

範例

範例

此指令會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" }

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: