华为云用户手册

接口介绍 裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。 通过配合使用BMS服务提供的接口和OpenStack原生接口，您可以完整地使用裸金属服务器的所有功能。例如创建裸金属服务器实例，可以使用OpenStack原生接口，也可以使用BMS接口进行创建。 表1 接口说明 类型 子类型 说明 BMS接口 查询API版本信息 查询裸金属服务器服务当前所用的API版本。 生命周期管理 可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。 状态管理 裸金属服务器修改名称、重装系统、启动、重启、关闭等功能。 规格管理 用于查询裸金属服务器的规格详情和规格扩展信息，比如规格ID、规格名称、CPU核数、启动源。 网卡管理 可以查询裸金属服务器网卡信息，比如网卡的IP地址、MAC地址。 云硬盘管理 裸金属服务器云硬盘挂载、卸载，以及挂载的磁盘信息查询。 元数据管理 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以更新裸金属服务器的元数据。 租户配额管理 查询某租户名下，所有资源的配额信息，包括已使用配额。 密码管理 查询是否支持一键重置密码，如果支持，您可以对裸金属服务器重置密码。还包括Windows裸金属服务器的密码获取与清除。 查询Job状态 对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回“job_id”，通过“job_id”可以查询任务的执行状态。 OpenStack原生接口（v2.1版本） 生命周期管理 查询类接口，包括查询裸金属服务器详情、查询裸金属服务器列表、查询裸金属服务器详情信息列表。 状态管理 状态管理接口，包括对裸金属服务器的启动、重启、关闭等接口。 元数据管理 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。 IP信息查询 查询裸金属服务器的私有IP地址信息，包括IP地址版本（IPv4或者IPv6）和具体的IP地址。 裸金属服务器规格查询 查询裸金属服务器规格信息列表：查询系统中的所有规格，或者指定过滤条件检索需要的规格。 查询裸金属服务器规格详情：根据裸金属服务器的规格ID，查询规格的详细信息，比如规格名称、CPU核数、内存大小等。 查询裸金属服务器规格extra_specs参数的详情：“extra_specs”参数用于描述裸金属服务器规格的键值对，如果您想确认某个规格是否支持快速发放，可以调用该接口进行查询。 裸金属服务器网卡查询 您可以查询裸金属服务器的所有网卡；或者根据网卡ID，查询某一个网卡的详细信息，比如网卡的IP地址、MAC地址。 云硬盘管理 您可以查询裸金属服务器所挂载的云硬盘信息；或者根据磁盘ID，查询裸金属服务器挂载的某个云硬盘信息，比如挂载目录。 SSH密钥管理 查询SSH密钥信息列表、详情，创建、删除SSH密钥等功能。 一维标签管理 裸金属服务器一维标签的增删改查。 使用BMS提供的接口时，您需要使用BMS服务自身的Endpoint。 使用OpenStack原生接口时，您需要使用E CS 服务注册的Endpoint。 当前版本调用OpenStack接口不支持HTTP长连接。

响应示例 1 2 3 4 5 6 7 8 9 10 { "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "version": 4, "addr": "192.168.2.90" } ] } }

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "interfaceAttachment": { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", "ip_address": "192.168.1.3" } ], "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "mac_addr": "fa:16:3e:4c:2c:30" } }

请求示例 查询ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器上ID为ce531f90-199f-48c0-816c-13e38010b442的网卡信息。 1 GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface/ce531f90-199f-48c0-816c-13e38010b442

URI GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 id 是 网卡ID。 可以在裸金属服务器详情页面“网卡”页签中查看；也可以通过查询裸金属服务器网卡信息（OpenStack原生）API获取，对应的是参数“port_id”的取值。

响应参数 参数 参数类型 描述 interfaceAttachment Object 裸金属服务器网卡信息列表，详情请参见表2。 表2 interfaceAttachment字段数据结构说明 参数 参数类型 描述 port_state String 网卡端口状态，取值为：ACTIVE、BUILD、DOWN。 fixed_ips Array of objects 网卡IP信息列表，详情请参见表3。 net_id String 网卡端口所属子网的网络ID（network_id）。 port_id String 网卡端口ID。 mac_addr String 网卡MAC地址信息。 表3 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡私网IP对应子网的子网ID（subnet_id）。 ip_address String 网卡IP地址。

请求示例 关闭ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器。 1 POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action 1 2 3 { "os-stop": {} }

响应示例 { "flavors": [ { "name": "physical.o2.medium", "links": [ { "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", "rel": "self" }, { "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", "rel": "bookmark" } ], "ram": 321725, "OS-FLV-DISABLED:disabled": false, "vcpus": 56, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 3725, "id": "physical.o2.medium" } ] }

响应参数 参数 参数类型 描述 flavors Array of objects 裸金属服务器规格列表。详情请参见表3。 表3 flavors数据结构说明 参数 参数类型 描述 id String 裸金属服务器规格ID。 name String 裸金属服务器规格名称。 vcpus Integer 该裸金属服务器规格对应的CPU核数。 ram Integer 该裸金属服务器规格对应的内存大小，单位为MB。 disk Integer 该裸金属服务器规格对应要求的磁盘大小，单位为GB。 swap String 未使用。 OS-FLV-EXT-DATA:ephemeral Integer 未使用。 OS-FLV-DISABLED:disabled Boolean 未使用。 rxtx_factor Float 未使用。 os-flavor-access:is_public Boolean 未使用。 links Array of objects 规格相关快捷链接地址。详情请参见表4。 表4 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。

请求参数 查询裸金属服务器规格时可选的查询检索参数如表2所示。 表2 可选的查询检索参数 参数 是否必选 参数类型 描述 minDisk 否 String 最小的硬盘规格，单位GB，大于等于此规格的都可以查询到。 minRam 否 String 最小的内存规格，单位MB，大于等于此规格的都可以查询到。 sort_key 否 String 排序字段，默认值为：flavorid。可以指定的其他key为name/ memory_mb/vcpus，/root_gb/flavorid。 sort_dir 否 String 升序/降序排序。 可以指定的参数为asc/desc，默认值为：asc

请求示例 查询规格信息列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail 查询规格信息列表且最小的磁盘规格为3725GB。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建 IAM 用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1 2 3 4 POST https://iam.cn-north-1.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3.0/OS-USER/users

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint，比如“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求示例 修改ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器的元数据，其中自定义metadata键值对为key和value。 1 PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key} 1 2 3 4 5 { "meta": { "key": "value" } }

URI PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 key 是 待修改的裸金属服务器metadata键值。

响应示例 1 2 3 4 5 6 7 8 { "volumeAttachment": { "device": "/dev/vdb", "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" } }

响应参数 参数 参数类型 描述 volumeAttachment Object 裸金属服务器挂载信息列表。详情请参见表2。 表2 volumeAttachment字段数据结构说明 参数 参数类型 描述 device String 挂载目录，例如“/dev/vdb”。 id String 挂载资源ID。 serverId String 所属裸金属服务器ID。 volumeId String 挂载云磁盘ID。

请求示例 查询ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器上挂载的ID为b53f23bd-ee8f-49ec-9420-d1acfeaf91d6的云硬盘信息。 1 GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6

URI GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 volume_id 是 云硬盘ID。 可以通过查询裸金属服务器挂载的云硬盘信息（OpenStack原生）API查询裸金属服务器挂载的云硬盘列表。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "status": "SUC CES S", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "baremetalSingleCreate", "begin_time": "2019-04-25T20:04:47.591Z", "end_time": "2019-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "baremetalBatchCreate", "begin_time": "2019-04-25T20:04:34.604Z", "end_time": "2019-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }

响应参数 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功 RUNNING：运行中 FAIL：失败 INIT：正在初始化 PENDING_PAYMENT：包年/包月订单待支付 entities Object Job操作的对象。请参见表2。 根据不同Job类型，显示不同的内容。裸金属服务器相关操作显示server_id；网卡相关操作显示nic_id；有子Job时为子Job的详情。 job_id String Job ID。 job_type String Job的类型，包含以下类型： baremetalBatchCreate：批量创建裸金属服务器 baremetalBatchOperate：批量修改裸金属服务器电源状态 baremetalVolumeBootReinstallOs：重装快速发放裸金属服务器操作系统 baremetalReinstallOs：重装本地盘裸金属服务器操作系统 baremetalAttachVolume：挂载单个磁盘 baremetalDetachVolume：卸载单个磁盘 begin_time String 开始时间。 时间戳格式为ISO 8601，例如：2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601，例如：2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时，返回的错误消息。 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考状态码。 表2 entities字段数据结构说明 参数 参数类型 描述 sub_jobs_total Integer 子任务数量。没有子任务时为0。 sub_jobs Array of objects 每个子任务的执行信息。没有子任务时为空列表。请参见表3。 表3 sub_jobs字段数据结构说明 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功 RUNNING：运行中 FAIL：失败 INIT：正在初始化 entities Object Job操作的对象。根据不同Job类型，显示不同的内容。裸金属服务器相关操作显示server_id；网卡相关操作显示nic_id。 请参见表4。 job_id String Job ID。 job_type String Job的类型，包含以下类型： baremetalSingleCreate：创建单个裸金属服务器 baremetalSingleOperate：修改单个裸金属服务器电源状态 begin_time String 开始时间。 时间戳格式为ISO 8601，例如：2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601，例如：2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时，返回的错误消息。 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考状态码。 表4 entities字段数据结构说明 参数 参数类型 描述 server_id String 裸金属服务器相关操作显示server_id。 nic_id String 网卡相关操作显示nic_id。

URI GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 vpc_id 是 裸金属服务器所在虚拟私有云ID。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 { "server": { "tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77", "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.107", "version": 4 } ] }, "metadata": { "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" }, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" } ], "OS-EXT-STS:power_state": 1, "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", "os-extended-volumes:volumes_attached": [ { "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" }, { "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" }, { "id": "86e801c3-acc6-465d-890c-d43ba493f553" }, { "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" } ], "OS-EXT-SRV-ATTR:host": "bms.az1", "image": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" } ], "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" }, "OS-SRV-USG:terminated_at": null, "accessIPv4": "", "accessIPv6": "", "created": "2017-05-24T06:14:05Z", "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", "key_name": "$key_name", "flavor": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" } ], "id": "physical.83.medium" }, "security_groups": [ { "name": "0011b620-4982-42e4-ad12-47c95ca495c4" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", "user_id": "1311c433dd9b408886f57d695c229cbe", "name": "bms-83", "progress": 0, "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", "updated": "2017-05-25T03:40:25Z", "status": "ACTIVE" } }

响应参数 参数 参数类型 描述 keypairs Array of objects 密钥信息列表，详情请参见表2。 表2 keypairs字段数据结构说明 参数 参数类型 描述 keypair Object 密钥信息详情，详情请参见表3。 表3 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 type String 密钥类型，默认为“ssh”。 微版本2.2以上支持。 public_key String 密钥对应publicKey信息。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 { "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" } } ] }

URI DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应参数 参数 参数类型 描述 keypair Object SSH密钥信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 public_key String 密钥对应的公钥信息。 private_key String 密钥对应的私钥信息。 创建SSH密钥时，响应中包括private_key的信息。 导入SSH密钥时，响应中不包括private_key的信息。 user_id String 密钥所属用户ID。

响应示例 1 2 3 4 5 6 7 8 { "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" } }