}
返回值
正常返回值：
返回值 说明
200 服务器已成功处理了请求。
其他返回值请参考状态码。
错误码
请参考错误码。
5.9 裸金属服务器 SSH 密钥管理
5.9.1 查询 SSH 密钥列表（OpenStack 原生）
功能介绍
查询SSH密钥信息列表。
约束
不支持分页查询。
URI
GET /v2.1/{project_id}/os-keypairs 参数说明请参见表5-53。
表5-53 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
请求消息
● 请求参数 无
● 请求样例
GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs
响应消息
● 响应参数
参数 参数类型 描述
keypairs Array of objects 密钥信息列表，详情请参见表5-54。
表5-54 keypairs 字段数据结构说明
参数 参数类型 描述
keypair Object 密钥信息详情，详情请参见表5-55。
表5-55 keypair 字段数据结构说明
参数 参数类型 描述
fingerprint String 密钥对应指纹信息。
name String 密钥名称。
type String 密钥类型，默认为“ssh”。
微版本2.2以上支持。
public_key String 密钥对应publicKey信息。
● 响应样例
{ "keypairs": [ {
"keypair": {
"fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a", "name": "keypair-test",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/
RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV
+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/
k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova"
} } ] }
返回值
正常返回值：
返回值 说明
200 服务器已成功处理了请求。
其他返回值请参考状态码。
错误码
请参考错误码。
5.9.2 查询 SSH 密钥详情（OpenStack 原生）
功能介绍
根据SSH密钥名称查询指定SSH密钥。
URI
GET /v2.1/{project_id}/os-keypairs/{keypair_name}
参数说明请参见表5-56。
表5-56 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
keypair_name 是 密钥名称信息。
可以通过查询SSH密钥列表（OpenStack 原生）API获取。
请求消息
● 请求参数 无
● 请求样例
GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
响应消息
● 响应参数
参数 参数类型 描述
keypair Object SSH密钥信息，详情请参见表 5-57。
表5-57 keypair 字段数据结构说明
参数 参数类型 描述
public_key String 密钥对应publicKey信息。
name String 密钥名称。
fingerprint String 密钥对应指纹信息。
created_at String 密钥创建时间。
时间戳格式为ISO 8601，例如：
2019-05-07T12:06:13.681238 deleted Boolean 密钥删除标记。
● true：表示密钥已被删除。
● false：表示密钥未被删除。
deleted_at String 密钥删除时间。
时间戳格式为ISO 8601，例如：
2019-05-07T12:06:13.681238
id String 密钥ID。
updated_at String 密钥更新时间。
时间戳格式为ISO 8601，例如：
2019-05-07T12:06:13.681238
user_id String 密钥所属用户信息。
● 响应样例
{ "keypair": {
"created_at": "2019-05-07T12:06:13.681238", "deleted": false,
"deleted_at": null,
"fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", "id": 1,
"name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/
oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/
kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/
Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd +GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/
QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/
9IXRx1ERImsqZnE9usB Generated-by-Nova", "updated_at": null,
"user_id": "fake"
} }
返回值
正常返回值：
返回值 说明
200 服务器已成功处理了请求。
其他返回值请参考状态码。
错误码
请参考错误码。
5.9.3 创建和导入 SSH 密钥（OpenStack 原生）
功能介绍
创建SSH密钥，或把公钥导入系统，生成密钥对。
创建SSH密钥成功后，请把响应数据中的私钥内容保存到本地文件，用户使用该私钥 登录裸金属服务器。为保证裸金属服务器安全，私钥数据只能读取一次，请妥善保 管。
URI
POST /v2.1/{project_id}/os-keypairs 参数说明请参见表5-58。
表5-58 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
请求消息
● 请求参数 说明
创建SSH密钥时，只需要提交SSH密钥的name属性。导入SSH密钥时，才需要提交 public_key属性。
参数 是否必选 参数类型 描述
keypair 是 Object 创建或导入的SSH密钥信息，
详情请参见表5-59。
表5-59 keypair 字段数据结构说明
参数 是否必选 参数类型 描述
public_key 否 String 导入的公钥信息。导入公钥最 大长度为1024字节。
注：长度超过1024字节会导致 裸金属服务器注入该密钥失 败。
name 是 String 密钥名称。
新创建的密钥名称不能和已有 密钥名称相同。
● 请求样例
POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs { "keypair": {
"name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", "public_key": "ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/
Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD +htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n"
} }
响应消息
● 响应参数
参数 参数类型 描述
keypair Object SSH密钥信息，详情请参见表 5-60。
表5-60 keypair 字段数据结构说明
参数 参数类型 描述
fingerprint String 密钥对应指纹信息。
name String 密钥名称。
public_key String 密钥对应的公钥信息。
private_key String 密钥对应的私钥信息。
● 创建SSH密钥时，响应中包括 private_key的信息。
● 导入SSH密钥时，响应中不包括 private_key的信息。
user_id String 密钥所属用户ID。
● 响应样例
{ "keypair": {
"public_key": "ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/
Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD +htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n",
"user_id": "f882feb345064e7d9392440a0f397c25",
"name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", "fingerprint": "35:9d:d0:c3:4a:80:d3:d8:86:f1:ca:f7:df:c4:f9:d8"
} }
返回值
正常返回值：
返回值 说明
200 服务器已成功处理了请求。
其他返回值请参考状态码。
错误码
请参考错误码。
5.9.4 删除 SSH 密钥（OpenStack 原生）
功能介绍
根据SSH密钥的名称，删除指定SSH密钥。
URI
DELETE /v2.1/{project_id}/os-keypairs/{keypair_name}
参数说明请参见表5-61。
表5-61 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
keypair_name 是 密钥名称。
可以通过查询SSH密钥列表（OpenStack 原生）API获取。
请求消息
● 请求参数 无
● 请求样例
DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
响应消息
不涉及。
返回值
正常返回值：
返回值 说明
204 服务器成功处理了请求，但没有返回任何内
容。
其他返回值请参考状态码。
错误码
请参考错误码。