API概览
接口介绍
裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。
通过配合使用BMS服务提供的接口和OpenStack原生接口，您可以完整地使用裸金属服务器的所有功能。例如创建裸金属服务器实例，可以使用OpenStack原生接口，也可以使用BMS接口进行创建。
|
类型 |
子类型 |
描述 |
|---|---|---|
|
BMS接口 |
可以实现裸金属服务器详情查询。 |
|
|
修改裸金属服务器的名称。 |
||
|
裸金属服务器挂卸载云硬盘。 |
||
|
对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回“job_id”，通过“job_id”可以查询任务的执行状态。 |
||
|
OpenStack原生接口（v2.1版本） |
创建、删除与查询类接口，可查询裸金属服务器的详情、列表、详情信息列表。 |
|
|
状态管理接口，包括对裸金属服务器的启动、重启、关闭等接口。 |
||
|
裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。 |
||
|
查询裸金属服务器的私有IP地址信息，包括IP地址版本（IPv4或者IPv6）和具体的IP地址。 |
||
|
||
|
您可以查询裸金属服务器的所有网卡；或者根据网卡ID，查询某一个网卡的详细信息，比如网卡的IP地址、MAC地址。 |
||
|
您可以查询裸金属服务器所挂载的云硬盘信息；或者根据磁盘ID，查询裸金属服务器挂载的某个云硬盘信息，比如挂载目录、云硬盘ID。 |
||
|
查询SSH密钥信息列表、详情，创建、删除SSH密钥等功能。 |
||
|
裸金属服务器一维标签的增删改查。 |
- 使用BMS提供的接口时，您需要使用BMS服务自身的Endpoint。
- 使用OpenStack原生接口时，您需要使用ECS服务注册的Endpoint。
- 当前版本调用OpenStack接口不支持HTTP长连接。
BMS接口使用限制
|
类型 |
API |
URI |
使用限制 |
|---|---|---|---|
|
生命周期管理 |
GET /v1/{project_id}/baremetalservers/{server_id} |
每分钟600次 |
|
|
状态管理 |
PUT /v1/{project_id}/baremetalservers/{server_id} |
每分钟100次 |
|
|
磁盘管理 |
POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume |
每分钟100次 |
|
|
DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} |
每分钟100次 |
||
|
Job管理 |
GET /v1/{project_id}/jobs/{jobId} |
每分钟2000次 |
