DeleteKeyPairs - 删除密钥对--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DeleteKeyPairs - 删除密钥对

最近更新时间：2024.09.29 11:41:09首次发布时间：2022.07.01 09:11:03

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DeleteKeyPairs	要执行的操作，取值：DeleteKeyPairs。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
KeyPairNames.N	Array of String	是	KeyPairNames.1=ssh_key_pair1&KeyPairNames.2=ssh_key_pair2	密钥对名称，最多支持100个。参数 - N：表示密钥对的序号。多个密钥对之间用&分隔。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

说明

仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误，将不会提示接口错误码，且接口的返回状态码将为200，但这并不代表对所有密钥对的操作均已成功，单个密钥对的操作结果请参见如下返回参数中的信息。

参数	类型	示例值	描述
OperationDetails	Array of Object	--	操作详情。

请求示例

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."
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	IdempotentParameterMismatch	The 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.	幂等参数不一致。
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MaximumKeyPairNames	You've reached the limit on the number of KeyPairNames that you can set.	指定的密钥对名称数量超过最大限制。
400	MissingParameter.KeyPairNames	The required parameter KeyPairNames is not supplied.	密钥对名称不能为空。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
429	FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。