文档

AttachKeyPair - 绑定SSH密钥对到Linux实例

更新时间:

调用AttachKeyPair绑定一个SSH密钥对到一台或多台Linux实例。

接口说明

当您使用该接口时,需要注意:

  • Windows 实例不支持 SSH 密钥对。
  • 绑定 SSH 密钥对后,将禁用用户名加密码的验证方式。
  • 如果实例处于运行中(Running)状态,重启实例( RebootInstance )后,SSH 密钥对生效。
  • 如果实例处于已停止(Stopped)状态,启动实例( StartInstance )后,SSH 密钥对生效。
  • 如果实例已经绑定了 SSH 密钥对,新的 SSH 密钥对自动替换原来的 SSH 密钥对。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:AttachKeyPairWrite
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • KeyPair
    acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}

请求参数

名称类型必填描述示例值
RegionIdstring

SSH 密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
KeyPairNamestring

SSH 密钥对名称。

testKeyPairName
InstanceIdsstring

绑定 SSH 密钥对的实例 ID。取值可以由多台实例 ID 组成一个 JSON 数组,最多支持 50 个 ID,ID 之间用半角逗号(,)隔开。

["i-bp1gtjxuuvwj17zr****", "i-bp17b7zrsbjwvmfy****", … "i-bp1h6jmbefj1ytos****"]

返回参数

名称类型描述示例值
object
KeyPairNamestring

密钥对的名称。

testKeyPairName
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountstring

绑定密钥对的实例总数量。

2
FailCountstring

绑定密钥对失败的实例数量。

0
Resultsobject []

绑定密钥对成功或失败的结果集合。

Codestring

传递的操作状态码,其中 200 表示操作成功。

200
Messagestring

传递的操作信息,当 code=200 时,message 为 successful。

successful
InstanceIdstring

实例 ID。

i-m5eg7be9ndloji64****
Successstring

此次操作是否成功。

true

示例

正常返回示例

JSON格式

{
  "KeyPairName": "testKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": "2",
  "FailCount": "0",
  "Results": {
    "Result": [
      {
        "Code": "200",
        "Message": "successful",
        "InstanceId": "i-m5eg7be9ndloji64****",
        "Success": "true"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidKeyPairName.NotFoundThe specified KeyPairName does not exist in our records.指定的 KeyPairName 不存在。
400InvalidInstanceIds.ValueNotSupportedThe specified parameter InstanceIds is not valid.指定的 InstanceIds 参数有误。
400DependencyViolation.IoOptimizeThe specified parameter InstanceIds is not valid.指定的实例 ID 不合法,指定的实例 IO 优化配置不合法。
403DependencyViolation.WindowsInstanceThe instance creating is windows, cannot use ssh key pair to login指定的实例是 Windows 操作系统,此类实例不支持 SSH 密钥对登录。
403InstanceKeyPairLimitExceededThe specified instances are beyond the permitted range.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
  • 本页导读 (1)