AttachKeyPair - 绑定密钥对--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

AttachKeyPair - 绑定密钥对

最近更新时间：2024.10.28 17:36:25首次发布时间：2022.07.01 09:10:46

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	AttachKeyPair	要执行的操作，取值：AttachKeyPair。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
KeyPairId	String	否	kp-ybqcopwrdwl8j1******	密钥对唯一ID，可以调用DescribeKeyPairs接口查询。 `KeyPairName`与`KeyPairId`不允许同时为空。如果同时设置了`KeyPairName`与`KeyPairId`，则优先生效`KeyPairId`。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
InstanceIds.N	Array of String	是	InstanceIds.1=i-ahipakt2gcg95jpv**&InstanceIds.2=i-ahipakt2gdg95lbe**	实例ID，最多支持100个。参数 - N：表示实例的序号。多个Instance ID之间用&分隔。
KeyPairName	String	否	ssh_key_pair	密钥对名称。 `KeyPairName`与`KeyPairId`不允许同时为空。如果同时设置了`KeyPairName`与`KeyPairId`，则优先生效`KeyPairId`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

说明

仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误，将不会提示接口错误码，且接口的返回状态码将为200，但这并不代表对所有密钥对的操作均已成功，单个密钥对的操作结果请参见如下返回参数中的信息。

参数	类型	示例值	描述
OperationDetails	Array of Object	--	操作详情。

请求示例

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."
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.KeyPairNameAndKeyPairId	The required parameters KeyPairName and KeyPairId are not supplied.	密钥对名称和ID不能同时为空。
400	IdempotentParameterMismatch	The 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.	幂等参数不一致。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
400	LimitExceeded.MaximumInstanceIds	You've reached the limit on the number of InstanceIds that you can set.	指定的InstanceIds数量超过最大限制。
400	MissingParameter.InstanceIds	The required parameter InstanceIds is not supplied.	参数实例ID不能为空。
404	InvalidKeyPair.NotFound	The specified KeyPair does not exist.	指定的密钥对不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。