綁定一個 SSH 金鑰對到一台或多台 Linux 執行個體。

描述

當您使用該介面時，需要注意：

  • Windows 執行個體不支援 SSH 金鑰對。

  • 綁定 SSH 金鑰對後，將禁用使用者名加密碼的驗證方式。

  • 如果執行個體處於 運行中（Running）狀態，重啟執行個體（RebootInstance）後，SSH 金鑰對生效。

  • 如果執行個體處於 已停止（Stopped）狀態，啟動執行個體（StartInstance）後，SSH 金鑰對生效。

  • 如果執行個體已經綁定了 SSH 金鑰對，新的 SSH 金鑰對自動替換原來的 SSH 金鑰對。

請求參數

名稱 類型 是否必需 描述
Action String 是 系統規定參數。取值：AttachKeyPair
RegionId String 是 SSH 金鑰對所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。
KeyPairName String 是 SSH 金鑰對名稱。
InstanceIds String 是 綁定 SSH 金鑰對的執行個體 ID。取值可以由多台執行個體 ID 組成一個 JSON 數組，格式為 ["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"]，最多支援 50 個 ID，ID 之間用半形逗號（,）隔開。

返回參數

全是公共返回參數。參閱 公共參數。

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=AttachKeyPair
&RegionId=cn-qingdao
&KeyPairName=test
&InstanceIds=["i-XXXXX"]
&<公共請求參數>
返回樣本

XML 格式

<AttachKeyPairResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</AttachKeyPairResponse>
JSON 格式 
{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API 錯誤中心。

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您需要指定參數 RegionId。或者您暫時無法使用該地域的資源。
DependencyViolation.WindowsInstance The instance creating is window, cannot use ssh key pair to login 403 Windows 執行個體不支援 SSH 金鑰對。
InvalidKeyPairName.NotFound The specified KeyPairName does not exist in our records. 404 指定的 KeyPairName 不存在。
InvalidRegionId.NotFound The specified RegionId does not exist. 404 指定的 RegionId 不存在。