接口功能介绍
此接口供用户用来删除SSH密钥对。系统会根据您输入的SSH密钥对的名称删除对应的密钥对，并返回删除成功信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
若已有ECS实例绑定了该SSH密钥对，则该SSH密钥对不支持被删除。
URI
POST /v4/ecs/keypair/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| keyPairName | 是 | String | 密钥对名称。满足以下规则：只能由数字、字母、-组成，不能以数字和-开头、以-结尾，且长度为2-63字符。 | KeyPair-a589 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| keyPairName | String | 密钥对名称 | KeyPair-a589 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：在华东1资源池删除名称为"keypair-test1"的密钥对
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"keyPairName":"keypair-test1"
}
响应示例
{
"returnObj":{
"keyPairName":"keypair-test1"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
