# API概览 #### 接口介绍 裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。 表1接口说明 | 类型 | 子类型 | 说明 | |:---|:---|:---| | BMS接口 | [查询API版本信息](https://support.huaweicloud.com/api-bms/bms_api_0602.html) | 查询裸金属服务器服务当前所用的API版本。 | | BMS接口 | [生命周期管理](https://support.huaweicloud.com/api-bms/bms_api_0605.html) | 可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。 | | BMS接口 | [状态管理](https://support.huaweicloud.com/api-bms/bms_api_0610.html) | 裸金属服务器修改名称、重装系统、启动、重启、关闭等功能。 | | BMS接口 | [规格管理](https://support.huaweicloud.com/api-bms/bms_api_0618.html) | 用于查询裸金属服务器的规格详情和规格扩展信息，比如规格ID、规格名称、CPU核数、启动源。 | | BMS接口 | [网卡管理](https://support.huaweicloud.com/api-bms/bms_api_0620.html) | 可以查询裸金属服务器网卡信息，比如网卡的IP地址、MAC地址。 | | BMS接口 | [云硬盘管理](https://support.huaweicloud.com/api-bms/bms_api_0625.html) | 裸金属服务器云硬盘挂载、卸载，以及挂载的磁盘信息查询。 | | BMS接口 | [元数据管理](https://support.huaweicloud.com/api-bms/bms_api_0630.html) | 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以更新裸金属服务器的元数据。 | | BMS接口 | [租户配额管理](https://support.huaweicloud.com/api-bms/bms_api_0632.html) | 查询某租户名下，所有资源的配额信息，包括已使用配额。 | | BMS接口 | [密码管理](https://support.huaweicloud.com/api-bms/bms_api_0634.html) | 查询是否支持一键重置密码，如果支持，您可以对裸金属服务器重置密码。还包括Windows裸金属服务器的密码获取与清除。 | | BMS接口 | [查询Job状态](https://support.huaweicloud.com/api-bms/bms_api_0639.html) | 对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回"job_id"，通过"job_id"可以查询任务的执行状态。 | | OpenStack原生接口（v2.1版本） | [生命周期管理](https://support.huaweicloud.com/api-bms/bms_api_0705.html) | 查询类接口，包括查询裸金属服务器详情、查询裸金属服务器列表、查询裸金属服务器详情信息列表。 | | OpenStack原生接口（v2.1版本） | [状态管理](https://support.huaweicloud.com/api-bms/bms_api_0711.html) | 状态管理接口，包括对裸金属服务器的启动、重启、关闭等接口。 | | OpenStack原生接口（v2.1版本） | [元数据管理](https://support.huaweicloud.com/api-bms/bms_api_0717.html) | 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。 | | OpenStack原生接口（v2.1版本） | [IP信息查询](https://support.huaweicloud.com/api-bms/bms_api_0722.html) | 查询裸金属服务器的私有IP地址信息，包括IP地址版本（IPv4或者IPv6）和具体的IP地址。 | | OpenStack原生接口（v2.1版本） | [裸金属服务器规格查询](https://support.huaweicloud.com/api-bms/bms_api_0725.html) | - [查询裸金属服务器规格信息列表](https://support.huaweicloud.com/api-bms/bms_api_0726.html)：查询系统中的所有规格，或者指定过滤条件检索需要的规格。 - [查询裸金属服务器规格详情](https://support.huaweicloud.com/api-bms/bms_api_0727.html)：根据裸金属服务器的规格ID，查询规格的详细信息，比如规格名称、CPU核数、内存大小等。 - [查询裸金属服务器规格extra_specs参数的详情](https://support.huaweicloud.com/api-bms/bms_api_0728.html)："extra_specs"参数用于描述裸金属服务器规格的键值对，如果您想确认某个规格是否支持快速发放，可以调用该接口进行查询。 | | OpenStack原生接口（v2.1版本） | [裸金属服务器网卡查询](https://support.huaweicloud.com/api-bms/bms_api_0729.html) | 您可以查询裸金属服务器的所有网卡；或者根据网卡ID，查询某一个网卡的详细信息，比如网卡的IP地址、MAC地址。 | | OpenStack原生接口（v2.1版本） | [云硬盘管理](https://support.huaweicloud.com/api-bms/bms_api_0732.html) | 您可以查询裸金属服务器所挂载的云硬盘信息；或者根据磁盘ID，查询裸金属服务器挂载的某个云硬盘信息，比如挂载目录。 | | OpenStack原生接口（v2.1版本） | [SSH密钥管理](https://support.huaweicloud.com/api-bms/bms_api_0737.html) | 查询SSH密钥信息列表、详情，创建、删除SSH密钥等功能。 | | OpenStack原生接口（v2.1版本） | [一维标签管理](https://support.huaweicloud.com/api-bms/bms_api_0742.html) | 裸金属服务器一维标签的增删改查。 | ![](https://support.huaweicloud.com/api-bms/public_sys-resources/note_3.0-zh-cn.png) - 使用BMS提供的接口时，您需要使用BMS服务自身的Endpoint。 - 使用OpenStack原生接口时，您需要使用ECS服务注册的Endpoint。 - 当前版本调用OpenStack接口不支持HTTP长连接。 #### BMS接口使用限制 表2BMS接口使用限制 | 类型 | API | URI | 使用限制 | |:---|:---|:---|:---| | 查询API版本信息 | [查询API版本信息列表](https://support.huaweicloud.com/api-bms/bms_api_0603.html) | GET / | 每分钟2000次 | | 查询API版本信息 | [查询指定API版本信息](https://support.huaweicloud.com/api-bms/bms_api_0604.html) | GET /{api_version} | 每分钟2000次 | | 生命周期管理 | [创建裸金属服务器](https://support.huaweicloud.com/api-bms/bms_api_0606.html) | POST /v1/{project_id}/baremetalservers | 每分钟50次 | | 生命周期管理 | [查询裸金属服务器详情](https://support.huaweicloud.com/api-bms/bms_api_0608.html) | GET /v1/{project_id}/baremetalservers/detail | 每分钟500次 | | 生命周期管理 | [查询裸金属服务器详情列表](https://support.huaweicloud.com/api-bms/bms_api_0609.html) | GET /v1/{project_id}/baremetalservers/{server_id} | 每分钟1000次 | | 状态管理 | [修改裸金属服务器名称](https://support.huaweicloud.com/api-bms/bms_api_0611.html) | PUT /v1/{project_id}/baremetalservers/{server_id} | 每分钟100次 | | 状态管理 | [重装裸金属服务器操作系统](https://support.huaweicloud.com/api-bms/bms_api_0612.html) | POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos | 每分钟50次 | | 状态管理 | [启动裸金属服务器](https://support.huaweicloud.com/api-bms/bms_api_0613.html) | POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | | 状态管理 | [重启裸金属服务器](https://support.huaweicloud.com/api-bms/bms_api_0614.html) | POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | | 状态管理 | [关闭裸金属服务器](https://support.huaweicloud.com/api-bms/bms_api_0615.html) | POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | | 规格管理 | [查询规格详情和规格扩展信息列表](https://support.huaweicloud.com/api-bms/bms_api_0619.html) | GET /v1/{project_id}/baremetalservers/flavors | 每分钟500次 | | 网卡管理 | [查询裸金属服务器网卡信息](https://support.huaweicloud.com/api-bms/bms_api_0621.html) | GET /v1/{project_id}/baremetalservers/{server_id}/os-interface | 每分钟500次 | | 云硬盘管理 | [裸金属服务器挂载云硬盘](https://support.huaweicloud.com/api-bms/bms_api_0626.html) | POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume | 每分钟100次 | | 云硬盘管理 | [裸金属服务器卸载云硬盘](https://support.huaweicloud.com/api-bms/bms_api_0627.html) | DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} | 每分钟100次 | | 云硬盘管理 | [查询裸金属服务器挂载的磁盘信息](https://support.huaweicloud.com/api-bms/bms_api_0629.html) | GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments | 每分钟500次 | | 元数据管理 | [更新裸金属服务器元数据](https://support.huaweicloud.com/api-bms/bms_api_0631.html) | POST /v1/{project_id}/baremetalservers/{server_id}/metadata | 每分钟100次 | | 租户配额管理 | [查询租户配额](https://support.huaweicloud.com/api-bms/bms_api_0633.html) | GET /v1/{project_id}/baremetalservers/limits | 每分钟500次 | | 密码管理 | [查询是否支持一键重置密码](https://support.huaweicloud.com/api-bms/bms_api_0635.html) | GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag | 每分钟500次 | | 密码管理 | [一键重置裸金属服务器密码](https://support.huaweicloud.com/api-bms/bms_api_0636.html) | PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password | 每分钟50次 | | 密码管理 | [Windows裸金属服务器获取密码](https://support.huaweicloud.com/api-bms/bms_api_0637.html) | GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 每分钟50次 | | 密码管理 | [Windows裸金属服务器清除密码](https://support.huaweicloud.com/api-bms/bms_api_0638.html) | DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 每分钟50次 | | Job管理 | [查询Job状态](https://support.huaweicloud.com/api-bms/bms_api_0640.html) | GET /v1/{project_id}/jobs/{jobId} | 每分钟2000次 |