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

导出私钥 - ExportPrivateKey

功能介绍

导出指定密钥对的私钥。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kps:SSHKeyPair:exportPrivateKey

    Write

    SSHKeyPair *

    -
    • kps:domainKeypairs:exportpk

    kms:cmk:decryptDataKey

URI

POST /v3/{project_id}/keypairs/private-key/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

keypair

是

KeypairBean object

待导出私钥的的密钥对信息。
表4 KeypairBean

参数

是否必选

参数类型

描述

name

是

String

SSH密钥对名称。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

keypair

ExportPrivateKeyKeypairBean object

导出的私钥信息。
表6 ExportPrivateKeyKeypairBean

参数

参数类型

描述

name

String

SSH密钥对的名称。

private_key

String

SSH密钥对的私钥

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{
  "keypair" : {
    "name" : "demo2"
  }
}

响应示例

状态码：200

请求已成功

{
  "keypair" : {
    "name" : "demo2",
    "private_key" : "-----BEGIN RSA PRIVATE KEY-----..."
  }
}

状态码：400

Error response

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

状态码

状态码

描述

200

请求已成功

400

Error response

错误码

请参见错误码。

父主题： 密钥对管理