全部产品
Search
文档中心

轻量应用服务器:AttachKeyPair - 绑定密钥对

更新时间:Oct 30, 2024

轻量应用服务器绑定密钥对。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

指定的轻量数据库实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
InstanceIdsarray

轻量应用服务器实例 ID。最多支持 50 个实例 ID。

string

绑定 SSH 密钥对的实例 ID。最多支持 50 个实例 ID。

2ad1ae67295445f598017499dc****
KeyPairNamestring

密钥对名称。长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://或 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

test

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
TotalCountinteger

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

2
FailCountinteger

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

2
Resultsarray<object>

结果列表。

Resultobject

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

Codestring

结果码。

200
Messagestring

结果信息。

success
Successstring

绑定密钥对是否成功。可能值:

  • true:绑定密钥对成功。

  • false:绑定密钥对失败。

true
InstanceIdstring

实例 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错误码错误信息
404InvalidInstanceId.NotFoundThe specified Instance Id does not exist.

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

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 错误码发生变更查看变更详情