调用DeleteKeyPairs删除一对或者多对 SSH 密钥对。删除 SSH 密钥对后,我们不再为您保存该 SSH 密钥对,但是已经绑定的实例可以正常使用该 SSH 密钥对,其 SSH 密钥对名称仍然显示在实例详情中。

接口说明

调用该接口时,您需要注意:

  • 删除 SSH 密钥对后,您将无法通过 DescribeKeyPairs 查询该 SSH 密钥对。
  • 查询实例信息时(DescribeInstances),会显示 SSH 密钥对名称(KeyPairNames),不再显示该 SSH 密钥对的其他信息。

调试

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

请求参数

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

SSH 密钥对名称。取值可以由多个 SSH 密钥对名称组成一个 JSON 数组,最多支持 100 对 SSH 密钥对,名称之间用半角逗号(,)隔开。

RegionId String cn-hangzhou

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

Action String DeleteKeyPairs

系统规定参数。取值:DeleteKeyPairs

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DeleteKeyPairs
&RegionId=cn-qingdao
&KeyPairNames=test
&<公共请求参数>

正常返回示例

XML 格式

<DeleteKeyPairsResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DeleteKeyPairsResponse>

JSON 格式

{
	"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter The input parameter "KeyPairNames" that is mandatory for processing this request is not supplied. 未提供必需的 KeyPairNames。
400 InvalidKeyPairNames.ValueNotSupported The specified parameter "KeyPairNames" is not valid. 密钥对名称不合法,
403 InstanceKeyPairLimitExceeded Exceeding the allowed amount of instance which will be deleted. 要删除的实例数量达到上限。

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