You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DeleteKeyPairs

最近更新时间：2023.11.20 10:48:36

首次发布时间：2022.07.01 09:11:03

我的收藏

调用 DeleteKeyPairs 接口删除一个或多个密钥对。

说明

不允许删除已绑定实例的密钥对。若存在已绑定的实例，请先调用DetachKeyPair解绑密钥对。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填
示例值
描述
ActionString是DeleteKeyPairs要执行的操作，取值：DeleteKeyPairs。
VersionString是2020-04-01API的版本，取值：2020-04-01。

KeyPairNames.N

String

是

KeyPairNames.1=ssh_key_pair1&KeyPairNames.2=ssh_key_pair2

密钥对名称，最多支持100个密钥对。

  • 参数 - N：表示密钥对的序号。
  • 多个密钥对之间用&分隔。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

名称类型示例值描述

OperationDetails

Array of Struct

-

操作详情，具体请参见下表“ OperationDetails结构 ”。

OperationDetails结构

名称类型示例值描述
KeyPairNameStringssh_key_pair1操作的密钥对名称。
ErrorStruct-操作的实例错误信息，具体请参见下表“ Error结构 ”。

Error结构

名称类型示例值描述
CodeStringMissingParameter.KeyPairName批量请求处理中，单个请求操作失败的错误码，具体请参见下表“错误码（批量操作时具体单个请求失败的异常）”。
MessageStringThe required parameter KeyPairName is not supplied.批量请求处理中，单个请求的异常信息，具体请参见下表“错误码（批量操作时具体单个请求失败的异常）”。

错误码（批量操作时具体单个请求失败）

错误码错误信息描述

MissingParameter.KeyPairName

The required parameter KeyPairName is not supplied.

密钥对名称不能为空。

InvalidKeyPair.NotFoundThe specified KeyPair does not exist.指定的密钥对不存在。
InvalidKeyPair.InUseThe specified KeyPair is in use.指定的密钥对正在被使用。
FlowLimitExceededYou've reach the limit on request rate of resources.您已超过资源请求限速。

请求示例

GET /?Action=DeleteKeyPairs&Version=2020-04-01&KeyPairNames.1=ssh_key_pair1&KeyPairNames.2=ssh_key_pair2 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DeleteKeyPairs",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": [
            {
                "KeyPairName": "ssh_key_pair1",
                "Error": null
            },
            {
                "KeyPairName": "ssh_key_pair2",
                "Error": {
                    "Code": "InvalidKeyPair.NotFound",
                    "Message": "The specified KeyPair does not exist."
                }
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.KeyPairNamesThe required parameter KeyPairNames is not supplied.密钥对名称不能为空。
400LimitExceeded.MaximumKeyPairNamesYou've reached the limit on the number of KeyPairNames that you can set.指定的密钥对数量超过最大限制。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中，请稍后重试。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。