全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
云服务器 ECS

AttachKeyPair

更新时间:2017-11-21 15:32:02

描述

为 ECS 实例绑定 SSH 密钥对。当您使用该接口时,需要注意:

  • 该接口仅支持 Linux 实例。
  • 绑定 SSH 密钥对后,将禁用用户名加密码的验证方式。
  • 如果 ECS 实例处于已停止(Stopped)状态,加载的密钥对在实例启动后即可生效。
  • 如果 ECS 实例处于运行中(Running)状态,您需要重启实例(RebootInstance)使操作生效。
  • 如果 ECS 实例已经绑定了密钥对,再次绑定密钥对后,新的密钥对自动替换原来的密钥对。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:AttachKeyPair。
RegionId String 密钥对所在的地域 ID。RegionId 的列表详见 地域与可用区
KeyPairName String 需要加载的密钥对名称。
InstanceIds String 需要加载密钥对的实例 ID 集合。一个带有格式的 Json Array:[“instanceid1”,“instanceid2”, … “instanceidn”]。

返回参数

全是公共返回参数。请参阅文档 公共参数

错误码

错误代码 错误信息 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 不存在。

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=AttachKeyPair
  2. &RegionId=cn-qingdao
  3. & InstanceIds=["XXXXX"]
  4. & KeyPairName=test
  5. &<公共请求参数>

返回示例

XML 格式

  1. <AttachKeyPairResponse>
  2. <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  3. </AttachKeyPairResponse>

JSON 格式

  1. {
  2. "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
  3. }
本文导读目录