全部产品
Search
文档中心

云服务器 ECS:DetachKeyPair

更新时间:Sep 12, 2023

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

接口说明

使用该接口时,请注意:

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DetachKeyPair

系统规定参数。取值:DetachKeyPair

RegionId String cn-hangzhou

SSH密钥对所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

KeyPairName String testKeyPairName

SSH密钥对名称。

InstanceIds String ["i-bp1d6tsvznfghy7y****", "i-bp1ippxbaql9zet7****", … "i-bp1ib7bcz07l****"]

解绑SSH密钥对的实例ID。取值可以是由多台实例ID组成的一个JSON数组,最多支持50个ID,ID之间用半角逗号(,)隔开。

返回数据

名称

类型

示例值

描述

KeyPairName String testKeyPairName

密钥对的名称。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount String 2

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

FailCount String 0

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

Results Array of Result

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

Result
Code String 200

传递的操作状态码,其中200表示操作成功。

Message String successful

传递的操作信息。例如,当Code=200时,Messagesuccessful

InstanceId String i-bp1d6tsvznfghy7y****

实例ID。

Success String true

此次操作是否成功。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DetachKeyPair
&RegionId=cn-qingdao
&InstanceIds=["i-bp1d6tsvznfghy7y****", "i-bp1ippxbaql9zet7****", … "i-bp1ib7bcz07l****"]
&KeyPairName=testKeyPairName
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DetachKeyPairResponse>
	<TotalCount>2</TotalCount>
	<RequestId>834B3E6B-2D1D-482F-81A4-810C327D4735</RequestId>
	<Results>
		<Result>
			<Message>successful</Message>
			<InstanceId>i-m5eg7be9ndloji64****</InstanceId>
			<Success>true</Success>
			<Code>200</Code>
		</Result>
		<Result>
			<Message>successful</Message>
			<InstanceId>i-m5e25x2mwr0hk33d****</InstanceId>
			<Success>true</Success>
			<Code>200</Code>
		</Result>
	</Results>
	<FailCount>0</FailCount>
</DetachKeyPairResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "RequestId" : "834B3E6B-2D1D-482F-81A4-810C327D4735",
  "Results" : {
    "Result" : [ {
      "Message" : "successful",
      "InstanceId" : "i-m5eg7be9ndloji64****",
      "Success" : true,
      "Code" : "200"
    }, {
      "Message" : "successful",
      "InstanceId" : "i-m5e25x2mwr0hk33d****",
      "Success" : true,
      "Code" : "200"
    } ]
  },
  "FailCount" : 0
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidKeyPairName.NotFound The specified KeyPairName does not exist in our records. 指定的 KeyPairName 不存在。
400 InvalidInstanceIds.ValueNotSupported The specified parameter InstanceIds is not valid. 指定的 InstanceIds 参数有误。

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