文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理SSH密钥对/ 密钥对管理/ 批量导出密钥对私钥 - BatchExportPrivateKey
更新时间：2026-05-20 GMT+08:00
查看PDF
分享

批量导出密钥对私钥 - BatchExportPrivateKey

功能介绍

批量导出密钥对私钥，单次最多导出10条数据

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/keypairs/private-key/batch-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参数

参数

是否必选

参数类型

描述

[数组元素]

是

Array of Keypairs objects

待导出的密钥列表
表4 Keypairs

参数

是否必选

参数类型

描述

keypair

是

Keypair object

参数解释：

SSH密钥对信息

默认取值：

不涉及
表5 Keypair

参数

是否必选

参数类型

描述

name

否

String

参数解释：

密钥对名称由英文字母、数字、下划线、中划线组成，长度不能超过255个字节

取值范围：

不涉及

type

否

String

参数解释：

密钥对类型

取值范围：

  • ssh

  • x509

scope

否

String

参数解释：

密钥对所属域，租户级或用户级

取值范围：

  • domain

  • user

public_key

否

String

参数解释：

SSH密钥对对应的公钥信息

取值范围：

不涉及

fingerprint

否

String

参数解释：

SSH密钥对应指纹信息

取值范围：

不涉及

is_key_protection

否

Boolean

参数解释：

是否托管密钥

取值范围：

true或false

frozen_state

否

String

参数解释：

密钥冻结状态

取值范围：

  • 0：正常状态

  • 1：普通冻结

  • 2：公安冻结

  • 3：普通冻结及公安冻结

  • 4：违规冻结

  • 5：普通冻结及违规冻结

  • 6：公安冻结及违规冻结

  • 7：普通冻结、公安冻结及违规冻结

  • 8：未实名认证冻结

  • 9：普通冻结及未实名认证冻结

  • 10：公安冻结及未实名认证冻结

响应参数

状态码：200

请求已成功

无

请求示例

批量导出名称为”demo2，demo3， demo4"的SSH密钥对

[ {
  "keypair" : {
    "name" : "demo2"
  }
}, {
  "keypair" : {
    "name" : "demo3"
  }
}, {
  "keypair" : {
    "name" : "demo4"
  }
} ]

响应示例

状态码：200

请求已成功

"keypairs.zip"

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 密钥对管理

相关文档