使用AttachKeyPair为实例绑定密钥对-轻量应用服务器-阿里云

接口说明

一台轻量应用服务器只支持在控制台绑定一个密钥对。若您选择的轻量应用服务器已经绑定过其他密钥对，新绑定的密钥对将会覆盖已绑定的密钥对。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

swas-open:AttachKeyPair

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	指定的轻量数据库实例所属的地域 ID。您可以调用 ListRegions 查看支持的阿里云地域列表。	cn-hangzhou
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000
InstanceIds	array	是	轻量应用服务器实例 ID。最多支持 50 个实例 ID。
	string	否	绑定 SSH 密钥对的实例 ID。最多支持 50 个实例 ID。	2ad1ae67295445f598017499dc****
KeyPairName	string	是	密钥对名称。长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头，不能以 http://或 https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	30637AD6-D977-4833-A54C-CC89483E****
TotalCount	integer	绑定密钥对的实例总数量。	2
FailCount	integer	绑定密钥对失败的实例总数量。	2
Results	array<object>	结果列表。
	object	绑定密钥对成功或失败的结果集合。
Code	string	结果码。	200
Message	string	结果信息。	success
Success	string	绑定密钥对是否成功。可能值： true：绑定密钥对成功。 false：绑定密钥对失败。	true
InstanceId	string	实例 ID。	aa6e71ddb35c46679bc4753d6219d604

示例

正常返回示例

JSON格式

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 2,
  "FailCount": 2,
  "Results": [
    {
      "Code": "200",
      "Message": "success",
      "Success": "true",
      "InstanceId": "aa6e71ddb35c46679bc4753d6219d604"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidInstanceId.NotFound	The specified Instance Id does not exist.	指定的实例Id不存在

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

变更历史

更多信息，参考变更详情。