检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接口使用说明 查询API版本信息 裸金属服务器生命周期管理 裸金属服务器状态管理 裸金属服务器规格管理 裸金属服务器网卡管理 裸金属服务器云硬盘管理 裸金属服务器元数据管理 裸金属服务器租户配额管理 裸金属服务器密码管理 Job管理 裸金属服务器的标签管理 裸金属服务器SSH密钥管理（OpenStack原生）
API概览 接口介绍 裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。 表1 接口说明 类型 子类型 说明 BMS接口 查询API版本信息 查询裸金属服务器服务当前所用的API版本。 生命周期管理 可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。
历史API 接口使用说明（OpenStack Nova API） 查询API版本信息（OpenStack Nova API） 裸金属服务器生命周期管理（OpenStack Nova API） 裸金属服务器状态管理（OpenStack Nova API） 裸金属服务器元数据管理（OpenStack
如何调用API 构造请求 认证鉴权 返回结果
查询API版本信息（OpenStack Nova API） 查询API版本信息列表 查询指定API版本信息 父主题： 历史API
查询API版本信息 查询API版本信息列表 查询指定API版本信息 父主题： API
接口使用说明（OpenStack Nova API） 网络相关服务API，请参考《虚拟私有云API参考》。 专属分布式存储相关API，请参考《专属分布式存储API参考》。 使用OpenStack原生接口时，您需要使用ECS服务的终端节点（Endpoint），获取方式请参见地区和终端节点。
查询指定API版本信息 功能介绍 查询裸金属服务器指定API版本的信息。 调试 您可以在API Explorer中调试该接口。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 api_version 是 API版本号。例如：v1
查询指定API版本信息 功能介绍 返回指定API版本的信息。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 api_version 是 API版本号。例如：v2 请求参数 无 请求示例 查询v2版本的API版本信息。 1
版本ID（版本号），如v1。 links Array of objects API的URL地址。 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。 version String 若该版本API支持微版本，则为支持的最大微版本号；如果不支持微版本，则为空。
查询API版本信息列表 功能介绍 查询裸金属服务器当前所有可用的API版本。 调试 您可以在API Explorer中调试该接口。 URI GET / 请求参数 无 请求示例 查询当前所有可用的API版本。 1 GET https://{BMS Endpoint}/ 响应参数 参数
接口使用说明 网络相关服务API，请参考《虚拟私有云API参考》。 包周期裸金属服务器的创建和退订流程中涉及和运营类接口交互，详细信息请参见运营能力简介。 专属分布式存储相关API，请参考《专属分布式存储API参考》。 使用BMS提供的接口时，您需要使用BMS服务自身的终端节点（
请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。
查询裸金属服务器网卡信息 功能介绍 查询裸金属服务器的网卡信息，比如网卡的IP地址、MAC地址。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/baremetalservers/{server_id}/os-interface
请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。
获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（废弃）获取。 请求消息 请求参数 参数 是否必选 参数类型 描述 os-getSerialConsole 是 Object 获取裸金属服务器远程登录地址。详情请参见表2。
关闭裸金属服务器（废弃） 功能介绍 关闭单台裸金属服务器。如需操作多台裸金属服务器，可以使用关闭裸金属服务器API。 当前API已废弃，请使用“关闭裸金属服务器”。 约束 裸金属服务器状态（OS-EXT-STS:vm_state属性）必须是active或error。 当前仅支持强制关闭。
重启裸金属服务器（废弃） 功能介绍 重启单台裸金属服务器。 当前API已废弃，请使用“重启裸金属服务器”。 约束 当前仅支持强制重启。 URI POST /v2.1/{project_id}/servers/{server_id}/action 参数说明请参见表1。 表1 参数说明
查询Job状态 功能介绍 查询Job的执行状态。 对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回“job_id”，通过“job_id”可以查询任务的执行状态。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/jobs/{job_id}
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
