1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口 (DeleteKeyPairs) 用于删除已在腾讯云托管的密钥对。
- 可以同时删除多个密钥对。
- 不能删除已被实例或镜像引用的密钥对，所以需要独立判断是否所有密钥对都被成功删除。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeleteKeyPairs。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KeyIds.N | 是 | Array of String | 一个或多个待操作的密钥对ID。每次请求批量密钥对的上限为100。 可以通过以下方式获取可用的密钥ID： KeyId 获取密钥对ID。示例值：["skey-mv9yzyjj"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除密钥对
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DeleteKeyPairs
&KeyIds.0=skey-mv9yzyjj
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalServerError | 操作内部错误。 |
| InvalidKeyPair.LimitExceeded | 密钥对数量超过限制。 |
| InvalidKeyPairId.Malformed | 无效密钥对ID。指定的密钥对ID格式错误，例如 ID 长度错误skey-1122。 |
| InvalidKeyPairId.NotFound | 无效密钥对ID。指定的密钥对ID不存在。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.KeyPairNotSupported | 指定的密钥不支持当前操作。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| MissingParameter | 缺少参数错误。 |
