调用DeleteKeyPairs删除一对或者多对SSH密钥对。
接口说明
删除 SSH 密钥对后，您需要注意：
- 无法通过 DescribeKeyPairs 查询该 SSH 密钥对。
- 若已有 ECS 实例绑定了该 SSH 密钥对，则该 SSH 密钥对不支持被删除。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DeleteKeyPairs | delete | *KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | SSH 密钥对所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairNames | string | 是 | SSH 密钥对名称。取值可以由多个 SSH 密钥对名称组成一个 JSON 数组，最多支持 100 对 SSH 密钥对，名称之间用半角逗号（,）隔开。 说明
在进行删除 SSH 密钥对前，您可以调用 DescribeKeyPairs 查询已有密钥对。
| ["TestKeyPairName-1", "TestKeyPairName-2", … "TestKeyPairName-100"] |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter "KeyPairNames" that is mandatory for processing this request is not supplied. | - |
| 400 | InvalidKeyPairNames.ValueNotSupported | The specified parameter "KeyPairNames" is not valid. | 指定的参数“KeyPairNames”无效。 |
| 400 | InvalidParameter.KeypairAlreadyAttachedInstance | The specified parameter "KeyPairNames" attached to instances can not be deleted. | 指定的KeyPair存在关联的实例。 |
| 403 | InstanceKeyPairLimitExceeded | Exceeding the allowed amount of instance which will be deleted. | 要删除的密钥对数量达到上限。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |