删除SSH密钥对
接口功能介绍
此接口供用户用来删除SSH密钥对。系统会根据您输入的SSH密钥对的名称删除对应的密钥对,并返回删除成功信息。
接口约束
无
URI
POST /v4/ecs/keypair/delete
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
keyPairName | 是 | String | 密钥对名称 | KeyPair-a589 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中或失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误信息 | ||
description | String | 失败时的错误描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
keyPairName | String | 密钥对名称 | KeyPair-a589 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"keyPairName":"keypair-test1"
}
响应示例
{
"returnObj":{
"keyPairName":"keypair-test1"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.KeypairWorkorder.AccessFailed | 查询密钥对信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.keypair.NotExist | 密钥对不存在,请确认输入密钥对信息是否正确 |
Openapi.KeypairWorkorder.DeleteError | 删除密钥对失败,请重试。如果多次尝试失败,请提交工单 |