文档首页> 数据加密服务 DEW> API参考> API说明> 管理SSH密钥对> 密钥对任务管理> 绑定SSH密钥对
更新时间：2024-04-12 GMT+08:00
查看PDF
分享

绑定SSH密钥对

功能介绍

给指定的虚拟机绑定（替换或重置，替换需提供虚拟机已配置的SSH密钥对私钥；重置不需要提供虚拟机的SSH密钥对私钥）新的SSH密钥对。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/keypairs/associate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

keypair_name

是

String

SSH密钥对的名称

server

是

EcsServerInfo object

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

参数

是否必选

参数类型

描述

id

是

String

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

auth

否

Auth object

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

disable_password

否

Boolean

  • true：禁用虚拟机的ssh登录。

  • false：不禁用虚拟机的ssh登录。

port

否

Long

SSH监听端口。
表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

错误描述

请求示例

  • {
  "keypair_name" : "newkeypair1",
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----M..."
    }
  }
}
  • {
  "keypair_name" : "newkeypair2",
  "server" : {
    "id" : "d76baba7-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

错误码

请参见错误码。

父主题： 密钥对任务管理
分享：

    相关文档

    相关产品