从最多30台实例中批量解绑指定的密钥对,支持通过密钥对名或ID操作。
接口说明
请求说明
用于给实例解绑密钥对的批量接口,仅能操作关闭的实例。
单次解绑实例数量需不超过 30 个。
若发现密钥对名不等于 keyPairName 的实例,则抛出异常。
key_pair_name 和 key_pair_id 至少一个不为空。
调用时请传入 key_pair_id,key_pair_name 即将被舍弃。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KeyPairName |
string |
否 |
秘钥对名称。 |
test-kp |
| KeyPairId |
string |
否 |
秘钥对 id-唯一标识。 |
ssh-xxx |
| InstanceIds |
array |
是 |
实例 id。 |
["i-50f8q9mbfjzlkuk9znjglnne3"] |
|
string |
否 |
实例 ID。 |
i-xxxu |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
xx-xx-xx-xx |
| KeyPairId |
string |
密钥对的 ID。 |
ssh-xxx |
| KeyPairName |
string |
密钥对的名称。 |
test-kp |
| FailCount |
integer |
绑定密钥对失败的实例数量。 |
1 |
| TotalCount |
integer |
绑定密钥对的实例总数量。 |
3 |
| Results |
array<object> |
绑定密钥对成功或失败的结果集合。 |
|
|
object |
|||
| Code |
integer |
传递的操作状态码,其中 200 表示操作成功。 |
200 |
| InstanceId |
string |
实例 ID。 |
i-xxx |
| Message |
string |
传递的操作信息,当 code=200 时,message 为 successful。 |
successful |
| Success |
boolean |
此次操作是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "xx-xx-xx-xx",
"KeyPairId": "ssh-xxx",
"KeyPairName": "test-kp",
"FailCount": 1,
"TotalCount": 3,
"Results": [
{
"Code": 200,
"InstanceId": "i-xxx",
"Message": "successful",
"Success": true
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | PublicKeyNotAttachWithInstance | Public Key Not Attach With Instance. | 公钥未绑定到实例上 |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。