本接口用于删除密钥对。
使用限制:
使用中的密钥对不能被删除。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteSSHKey | 公共参数。该参数表示接口名称。取值:DeleteSSHKey。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
key_pair_identity | String | 是 | sshkey-6zdb7zcs9kh**** | 密钥对的 ID。您可以通过 ListSSHKey 接口获取密钥对 ID。 |
该接口无特有的返回参数。
POST https://veenedge.volcengineapi.com/?Action=DeleteSSHKey&Version=2021-04-30 &<其他公共参数> { "key_pair_identity":"sshkey-rdgpt4p9v7m****" }
{ "ResponseMetadata": { "RequestId": "2023052520542771951661E6B13212****", "Action": "DeleteSSHKey", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。