文档

DeleteKeyPairs - 删除一对SSH密钥对

更新时间:

调用DeleteKeyPairs删除一对SSH密钥对。

接口说明

  • 如果您成功删除密钥对,将无法通过 DescribeKeyPairs 查询该密钥对。
  • 如果您的 ENS 实例已经绑定了密钥对,在删除了该密钥对后,阿里云 ENS 不再为您保存该 SSH 密钥对,但是实例可以正常使用该 SSH 密钥对。调用 DescribeInstances 查询实例信息时,会显示密钥对名称(KeyPairName),但不再显示其他相关信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DeleteKeyPairsWrite
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
KeyPairNamestring

密钥对名称。命名规则如下所示:

  • 长度为 2~128 个英文或中文字符。
  • 必须以大小字母或中文开头,不能以http://https://开头。
  • 可以包含数字、半角冒号(:)、下划线(_)、或者连字符(-)。

在进行删除密钥对前,您可以调用 DescribeKeyPairs 查询已有密钥对。

TestKeyPairName
KeyPairIdstring

SSH 密钥对的 ID。

ssh-5lywanlkih1zo9yl8eg****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400PubKeyNameExistedPublic Key Pair Name Existed.密钥对名字已存在
400PubKeyAttachedWithInstancePublic Key Attached With Instance.密钥已绑定了实例
400InvalidPubKeyBodyInvalid Public Key Body.不合法的密钥
400PubKeyNameNotExistPublic Key Pair Name Not Exist.密钥对名字不存在
400CallInterfaceCall Interface Happen Error.接口调用出错。

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:KeyPairId
2023-12-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-10-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
入参OpenAPI 入参发生变更
    删除入参:Version
  • 本页导读 (1)
文档反馈