You need to enable JavaScript to run this app.
导航

AttachKeyPair

最近更新时间2023.11.20 10:48:36

首次发布时间2022.07.01 09:10:46

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

接口说明

  • 仅安装了密码插件的实例支持绑定密钥对,请先安装密码插件
  • 当前密钥对仅支持绑定 运行中已停止 两种状态的实例。
  • 如果您已通过控制台为实例绑定密钥对,本次新绑定的密钥对会覆盖已有密钥对,但对您手动在实例内部添加的密钥对无影响。
  • 绑定密钥对后密码登录方式自动失效,即如果您的实例已设置密码登录,绑定密钥对后,将无法再使用密码方式登录。
  • 绑定密钥对后需重启实例后,密钥对方可生效。

调试

请求参数

名称类型是否必填示例值描述
ActionStringAttachKeyPair要执行的操作,取值:AttachKeyPair。
VersionString2020-04-01API的版本,取值:2020-04-01。

InstanceIds.N

String

InstanceIds.1=i-ahipakt2gcg95jpv****&InstanceIds.2=i-ahipakt2gdg95lbe****

实例ID,最多支持100个ID。

  • 参数 - N:表示实例的序号。
  • 多个Instance ID之间用&分隔。

KeyPairName

String

ssh_key_pair

密钥对名称。

  • KeyPairNameKeyPairId不允许同时为空。
  • 如果同时设置了KeyPairNameKeyPairId,则优先生效KeyPairId

KeyPairId

String

kp-ybqcopwrdwl8j1******

密钥对唯一ID,可以调用DescribeKeyPairs接口查询。

  • KeyPairNameKeyPairId不允许同时为空。
  • 如果同时设置了KeyPairNameKeyPairId,则优先生效KeyPairId

ClientToken

String

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。
取值:仅支持ASCII字符,且不能超过64个字符。

返回数据

名称类型示例值描述

OperationDetails

Array of Struct

-

操作详情。具体请参见下表“ OperationDetails结构 ”。

OperationDetails结构

名称类型示例值描述
InstanceIdStringi-bp67acfmxazb4p****操作的实例ID。

Error

Struct

-

操作的实例错误信息。具体请参见下表“ Error结构 ”。

Error结构

名称类型示例值描述
CodeStringInvalidInstance.NotFound批量请求处理中,单个请求操作失败的错误码,具体请参见下表“错误码(批量操作时具体单个请求失败的异常)”。
MessageStringThe specified instance does not exist.批量请求处理中,单个请求的异常信息。具体请参见下表“错误码(批量操作时具体单个请求失败的异常)”。

错误码(批量操作时具体单个请求失败)

错误码错误信息描述

InvalidInstance.NotFound

The specified instance does not exist.

指定的实例不存在。

InvalidKeyPairForWindows.UnsupportedThe OSType of this specified instance is Windows, which does not support key pairs.指定的实例是Windows操作系统,不支持密钥对。
InvalidResetAuthenticationAgent.NotFoundThe specified reset-authentication agent does not install on the instance.指定的密码重置插件不存在。
InvalidInstanceStatusThe status of the specified instance does not support this request.当前的实例状态不支持此操作。
FlowLimitExceededYou've reach the limit on request rate of resources.您已超过资源请求限速。

请求示例

GET /?Action=AttachKeyPair&Version=2020-04-01&KeyPairName=ssh_key_pair1&InstanceIds.1=i-ahipakt2gcg95jpv****&InstanceIds.2=i-ahipakt2gdg95lbe**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "AttachKeyPair",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": [
            {
                "InstanceId": "i-ahipakt2gcg95jpv****",
                "Error": null
            },
            {
                "InstanceId": "i-ahipakt2gdg95lbe****",
                "Error": {
                    "Code": "InvalidInstance.NotFound",
                    "Message": "The specified instance does not exist."
                }
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.KeyPairNameAndKeyPairIdThe required parameters KeyPairName and KeyPairId are not supplied.密钥对名称与密钥对ID不允许同时为空。

400

MissingParameter.InstanceIds

The required parameter InstanceIds is not supplied.

实例ID不能为空。

400LimitExceeded.MaximumInstanceIdsYou've reached the limit on the number of InstanceIds that you can set.指定的InstanceIds数量超过最大限制。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
404InvalidKeyPair.NotFoundThe specified KeyPair does not exist.指定的密钥对不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中,请稍后重试。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。