调用DeleteKeyPairs删除一对或者多对SSH密钥对。

接口说明

删除SSH密钥对后，您需要注意：

  • 无法通过DescribeKeyPairs查询该SSH密钥对。
  • 若已有ECS实例绑定了该SSH密钥对：
    • 阿里云不再为您保存该SSH密钥对，但是实例可以正常使用该SSH密钥对。
    • 查询实例信息时（DescribeInstances），会显示SSH密钥对名称（KeyPairName），但不再显示其他相关信息。

调试

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

请求参数

名称 位置 类型 是否必选 示例值 描述
Action Query String 是 DeleteKeyPairs

系统规定参数。取值：DeleteKeyPairs
KeyPairNames Query String 是 ["skp-bp67acfmxazb41****", "skp-bp67acfmxazb42****", … "skp-bp67acfmxazb4p3***"]

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

RegionId Query String 是 cn-hangzhou

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

返回数据

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

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DeleteKeyPairs
&RegionId=cn-hangzhou
&KeyPairNames=["skp-bp67acfmxazb41****", "skp-bp67acfmxazb42****", … "skp-bp67acfmxazb4p3***"]
&<公共请求参数>

正常返回示例

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. 要删除的密钥对数量达到上限。

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