云主机

产品文档

云主机

deleteKeypair

描述

删除密钥。

详细操作说明请参考帮助文档:删除密钥

接口说明

  • 删除操作不影响已使用密钥的实例,即仍可使用本地保存的私钥进行登录。但密钥删除后,与其绑定的实例将自动更新资源关联状态,即实例侧更新为未绑定密钥的状态。
  • 如果使用密钥创建了实例模板,则在密钥删除后,将无法使用该模板创建高可用组。
  • 如果使用密钥创建了实例模板,并基于该模板创建了高可用组,则在密钥删除后,将导致高可用组不可用。

请求方式

DELETE

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/keypairs/{keyName}

名称 类型 是否必需 示例值 描述
regionId String cn-north-1 地域ID。
keyName String test 密钥名称。

请求参数

返回参数

名称 类型 示例值 描述
requestId String c2hmmaan8w06w19qcdfuic4w03f7ft2d 请求ID。

请求示例

DELETE

/v1/regions/cn-north-1/keypairs/my-test

返回示例

{
    "requestId": "aeb6716d70a99a8f1c5abc35eddb1830"
}

返回码

HTTP状态码 错误码 描述 错误解析
200 OK
404 NOT_FOUND Keypair 'xx' not found 密钥不存在。
500 INTERNAL Internal server error 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。
500 UNKNOWN Unknown server error 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。
更新时间:2021-09-01 20:20:29
文档反馈 docs feedback