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

描述

使用该接口时,请注意:

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

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
InstanceIds String ["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"]

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

KeyPairName String FinanceJoshuaV26

SSH 密钥对名称。

RegionId String cn-hangzhou

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

Action String DetachKeyPair

系统规定参数。取值:DetachKeyPair

返回参数

名称 类型 示例值 描述
FailCount String 0

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

KeyPairName String FinanceJoshuaV26

密钥对的名称。

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

请求 ID。无论调用接口成功与否,我们都会返回请求 ID。

Results

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

  └Code String 200

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

  └InstanceId String i-instanceid1

实例ID。

  └Message String successful

传递的操作信息,当code=200时,message为successful。

  └Success String true

此次操作是否成功。

TotalCount String 2

解绑密钥对的实例总数量

示例

请求示例


https://ecs.aliyuncs.com/?Action=DetachKeyPair
&RegionId=cn-qingdao
&InstanceIds=["i-xxxxxxx", "i-yyyyyyy"]
&KeyPairName=test
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
403 DependencyViolation.WindowsInstance The instance creating is windows, cannot use ssh key pair to login 指定的windows实例不支持解绑keypair。

查看本产品错误码