文档首页/密码安全中心 DEW/API参考/API说明/管理SSH密钥对/密钥对任务管理/解绑SSH密钥对 - DisassociateKeypair
更新时间：2025-10-16 GMT+08:00
查看PDF
分享

解绑SSH密钥对 - DisassociateKeypair

功能介绍

给指定的虚拟机解除绑定SSH密钥对并恢复SSH密码登录。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kps:SSHKeyPair:unbind

    Write

    SSHKeyPair *

    -

    • kps:domainKeypairs:unbind
    • ecs:serverKeypairs:unbind
    • ecs:cloudServers:createServers
    • ecs:cloudServers:deleteServers
    • ecs:cloudServers:showServer
    • ecs:cloudServers:attach
    • ecs:cloudServers:listServerBlockDevices
    • ecs:cloudServers:showServerBlockDevice
    • ecs:cloudServers:detachVolume
    • ecs:cloudServers:listServerInterfaces
    • ecs:cloudServers:listServersDetails
    • ecs:cloudServerFlavors:get
    • ecs:cloudServerQuotas:get
    • evs:types:get
    • evs:volumes:use
    • ims:images:get
    • vpc:subnets:list

URI

POST /v3/{project_id}/keypairs/disassociate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数

参数

是否必选

参数类型

描述

server

是

DisassociateEcsServerInfo object

需要绑定密钥对的虚拟机信息。

表4 DisassociateEcsServerInfo

参数

是否必选

参数类型

描述

id

是

String

需要绑定(替换或重置)SSH密钥对的虚拟机id

auth

否

Auth object

可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。

表5 Auth

参数

是否必选

参数类型

描述

type

否

String

取值为枚举类型。password或keypair。

key

否

String

  • type为枚举值password时，key表示密码；

  • type为枚举值keypair时，key表示私钥；

响应参数

状态码：202

表6 响应Body参数

参数

参数类型

描述

task_id

String

任务下发成功返回的ID。

server_id

String

绑定的虚拟机id。

status

String

任务下发的状态。SUCCESS或FAILED。

error_code

String

任务下发失败返回的错误码。

error_msg

String

任务下发失败返回的错误信息。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • {
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----\nM..."
    }
  }
}
  • {
  "server" : {
    "id" : "x76baba7-ef09-40a2-87ff-3eafec0696e7"
  }
}

响应示例

状态码：202

OK

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c"
}

状态码：400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

202

OK

400

Error response

错误码

请参见错误码。

父主题： 密钥对任务管理

相关文档