ImportSshPublicKey - AWS Transfer Family

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

ImportSshPublicKey

將 Secure Shell (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有金鑰部分。

AWS Transfer Family 接受 RSA、 ECDSA和 ED25519金鑰。

類型:字串

長度限制:長度下限為 0。長度上限為 2048。

必要:是

UserName

指派給一或多個伺服器的 Transfer Family 使用者名稱。

類型:字串

長度限制:長度下限為 3。長度上限為 100。

模式:[\w][\w@.-]{2,99}

必要:是

回應語法

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

回應元素

如果動作成功,服務會傳回 200 HTTP 個回應。

服務會以 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" }

另請參閱

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