更新时间:2026-05-20 GMT+08:00
分享

导出私钥 - 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。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

IAM服务查询用户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密钥对的私钥

取值范围:

不涉及

请求示例

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

响应示例

状态码:200

请求已成功

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档