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

批量导入SSH密钥对 - BatchImportKeypair

功能介绍

批量导入SSH密钥对,单次批量导入不得超过10条记录。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v3/{project_id}/keypairs/batch-import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

[数组元素]

是

Array of CreateKeypairRequestBody objects

创建密钥对请求体
表4 CreateKeypairRequestBody

参数

是否必选

参数类型

描述

keypair

是

CreateKeypairAction object

创建密钥对请求体请求参数
表5 CreateKeypairAction

参数

是否必选

参数类型

描述

name

是

String

SSH密钥对的名称。

  • 新创建的密钥对名称不能和已有密钥对的名称相同。

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

type

否

String

SSH密钥对的类型。ssh或x509。

public_key

否

String

导入公钥的字符串信息。

scope

否

String

租户级或者用户级。domain或user。

user_id

否

String

SSH密钥对所属的用户信息

key_protection

否

KeyProtection object

SSH密钥对私钥托管与保护。
表6 KeyProtection

参数

是否必选

参数类型

描述

private_key

否

String

导入SSH密钥对的私钥。

encryption

是

Encryption object

对私钥进行加密存储的方式。
表7 Encryption

参数

是否必选

参数类型

描述

type

是

String

取值范围：“kms”或“default”。

  • “default”为默认加密方式，适用于没有kms服务的局点。

  • “kms”为采用kms服务加密方式。

若局点没有kms服务，请填“default”。

kms_key_name

否

String

kms密钥的名称。

  • 若“type”为“kms”，则必须填入"kms_key_name"或"kms_key_id"。

kms_key_id

否

String

kms密钥的ID。

  • 若“type”为“kms”，则必须填入"kms_key_name"或"kms_key_id"。

响应参数

状态码：200

表8 响应Body参数

参数

参数类型

描述

failed_keypairs

Array of FailedKeypair objects

导入失败的SSH密钥对信息及导入失败的原因

succeeded_keypairs

Array of CreateKeypairResponseBody objects

成功导入的SSH密钥对信息
表9 FailedKeypair

参数

参数类型

描述

keypair_name

String

SSH密钥对名称

failed_reason

String

导入失败的原因
表10 CreateKeypairResponseBody

参数

参数类型

描述

keypair

CreateKeypairResp object

SSH密钥对信息详情
表11 CreateKeypairResp

参数

参数类型

描述

name

String

SSH密钥对的名称

type

String

SSH密钥对的类型。ssh或x509。

public_key

String

SSH密钥对对应的publicKey信息

private_key

String

SSH密钥对对应的privateKey信息

  • 创建SSH密钥对时，响应中包括private_key的信息。

  • 导入SSH密钥对时，响应中不包括private_key的信息。

fingerprint

String

SSH密钥对应指纹信息

user_id

String

SSH密钥对所属的用户信息

请求示例

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

[ {
  "keypair" : {
    "name" : "demo2",
    "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"
  }
}, {
  "keypair" : {
    "name" : "demo3",
    "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"
  }
} ]

响应示例

状态码：200

批量导入SSH密钥对响应信息

{
  "failed_keypairs" : [ {
    "keypair_name" : "demo3",
    "failed_reason" : "{\"error_code\":\"KPS.7004\", \"error_msg\":\"Key pair 'demo3' already exists.\"}"
  } ],
  "succeeded_keypairs" : [ {
    "keypair" : {
      "name" : "demo2",
      "fingerprint" : "SHA256:Wm91+h496cPk5JleSp4RdD2n4Z/5KdlDeD51lmiZ11M",
      "type" : "ssh",
      "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova",
      "user_id" : "6c2a33b1b8474d0dbac0a24297127525"
    }
  } ]
}

状态码

状态码

描述

200

批量导入SSH密钥对响应信息

错误码

请参见错误码。

父主题： 密钥对管理

相关文档