接口说明
删除密钥对(支持批量)。
注意事项：
- 若已有实例绑定了该SSH密钥对，则该SSH密钥对不支持被删除。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/delete
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
batchKeyPairDeleteReq
|
BatchKeyPairDeleteReq
|
是
|
batchKeyPairDeleteReq |
|
keyPairNames
|
<string> array
|
是
|
密钥对名称列表，可通过查询密钥列表获取。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/delete{
"keyPairNames":[
"testKeyPairOne",
"testKeyPairTwo"
]
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
KeyPairBatchAction«KeyPairBatchDeleteResultRecord»
|
请求成功时返回的数据。 |
|
batchResult
|
<KeyPairBatchDeleteResultRecord> array
|
密钥对批量操作结果集。 |
|
keyPairName
|
string
|
密钥对名称。 |
|
message
|
string
|
操作结果信息，失败时返回错误信息，成功时返回空字符串。 |
|
result
|
boolean
|
操作是否下发成功。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-5dcb336c816e41d8851c1fdc543a4025-7",
"state":"OK",
"body":{
"batchResult":[
{
"keyPairName":"testKeyPairOne",
"result":true,
"message":""
},
{
"keyPairName":"testKeyPairTwo",
"result":true,
"message":""
}
]
}
}