API概览
接口介绍
裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。
类型 | 子类型 | 说明 |
|---|---|---|
BMS接口 | 查询裸金属服务器服务当前所用的API版本。 | |
可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。 | ||
裸金属服务器修改名称、重装系统、启动、重启、关闭等功能。 | ||
用于查询裸金属服务器的规格详情和规格扩展信息，比如规格ID、规格名称、CPU核数、启动源。 | ||
可以查询裸金属服务器网卡信息，比如网卡的IP地址、MAC地址。 | ||
裸金属服务器云硬盘挂载、卸载，以及挂载的磁盘信息查询。 | ||
裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以更新裸金属服务器的元数据。 | ||
查询某租户名下，所有资源的配额信息，包括已使用配额。 | ||
查询是否支持一键重置密码，如果支持，您可以对裸金属服务器重置密码。还包括Windows裸金属服务器的密码获取与清除。 | ||
对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回“job_id”，通过“job_id”可以查询任务的执行状态。 | ||
OpenStack原生接口（v2.1版本） | 查询类接口，包括查询裸金属服务器详情、查询裸金属服务器列表、查询裸金属服务器详情信息列表。 | |
状态管理接口，包括对裸金属服务器的启动、重启、关闭等接口。 | ||
裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。 | ||
查询裸金属服务器的私有IP地址信息，包括IP地址版本（IPv4或者IPv6）和具体的IP地址。 | ||
| ||
您可以查询裸金属服务器的所有网卡；或者根据网卡ID，查询某一个网卡的详细信息，比如网卡的IP地址、MAC地址。 | ||
您可以查询裸金属服务器所挂载的云硬盘信息；或者根据磁盘ID，查询裸金属服务器挂载的某个云硬盘信息，比如挂载目录。 | ||
查询SSH密钥信息列表、详情，创建、删除SSH密钥等功能。 | ||
裸金属服务器一维标签的增删改查。 |
- 使用BMS提供的接口时，您需要使用BMS服务自身的Endpoint。
- 使用OpenStack原生接口时，您需要使用ECS服务注册的Endpoint。
- 当前版本调用OpenStack接口不支持HTTP长连接。
BMS接口使用限制
类型 | API | URI | 使用限制 |
|---|---|---|---|
查询API版本信息 | GET / | 每分钟2000次 | |
GET /{api_version} | 每分钟2000次 | ||
生命周期管理 | POST /v1/{project_id}/baremetalservers | 每分钟50次 | |
GET /v1/{project_id}/baremetalservers/detail | 每分钟500次 | ||
GET /v1/{project_id}/baremetalservers/{server_id} | 每分钟1000次 | ||
状态管理 | PUT /v1/{project_id}/baremetalservers/{server_id} | 每分钟100次 | |
POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos | 每分钟50次 | ||
POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | ||
POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | ||
POST /v1/{project_id}/baremetalservers/action | 每分钟50次 | ||
规格管理 | GET /v1/{project_id}/baremetalservers/flavors | 每分钟500次 | |
网卡管理 | GET /v1/{project_id}/baremetalservers/{server_id}/os-interface | 每分钟500次 | |
云硬盘管理 | POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume | 每分钟100次 | |
DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} | 每分钟100次 | ||
GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments | 每分钟500次 | ||
元数据管理 | POST /v1/{project_id}/baremetalservers/{server_id}/metadata | 每分钟100次 | |
租户配额管理 | GET /v1/{project_id}/baremetalservers/limits | 每分钟500次 | |
密码管理 | GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag | 每分钟500次 | |
PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password | 每分钟50次 | ||
GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 每分钟50次 | ||
DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 每分钟50次 | ||
Job管理 | GET /v1/{project_id}/jobs/{jobId} | 每分钟2000次 |
