DetachKeyPair - 为Linux实例解绑 SSH 密钥对_云服务器 ECS(ECS)-阿里云帮助中心

调用DetachKeyPair为一台或者多台Linux实例解绑SSH密钥对。

接口说明

使用该接口时，请注意：

解绑 SSH 密钥对后，您需要重启实例（ RebootInstance ）使更改生效。
解绑 SSH 密钥对后，实例默认使用用户名和密码的验证方式。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DetachKeyPair	update	Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	SSH 密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
KeyPairName	string	是	SSH 密钥对名称。	testKeyPairName
InstanceIds	string	是	解绑 SSH 密钥对的实例 ID。取值可以是由多台实例 ID 组成的一个 JSON 数组，最多支持 50 个 ID，ID 之间用半角逗号（,）隔开。	["i-bp1d6tsvznfghy7y**", "i-bp1ippxbaql9zet7", … "i-bp1ib7bcz07l**"]

返回参数

名称	类型	描述	示例值
	object
KeyPairName	string	密钥对的名称。	testKeyPairName
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	string	解绑密钥对的实例总数量。	2
FailCount	string	解绑密钥对失败的实例数量。	0
Results	array<object>	解绑密钥对成功或失败的结果集合。
Result	object
Code	string	传递的操作状态码，其中 200 表示操作成功。	200
Message	string	传递的操作信息。例如，当`Code=200`时，`Message`为`successful`。	successful
InstanceId	string	实例 ID。	i-bp1d6tsvznfghy7y****
Success	string	此次操作是否成功。	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.	指定的 KeyPairName 不存在。
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	指定的 InstanceIds 参数有误。
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login.	-
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.	-

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

变更历史

变更时间	变更内容概要	操作
2023-07-10	OpenAPI 错误码发生变更	查看变更详情