API Overview
API Introduction
Native OpenStack APIs and BMS APIs are provided.
A combination of the two types of APIs allows you to use all functions provided by the BMS service. For example, you can create a BMS using a native OpenStack API or a BMS API.
| Type | Function | Description |
|---|---|---|
| BMS APIs | Query the API version of the BMS service. | |
| Create yearly/monthly BMSs and query BMS details. | ||
| Change the BMS name, reinstall the BMS OS, start, restart, and stop BMSs. | ||
| Query BMS flavor details and extended flavor information, such as the flavor ID, flavor name, number of CPUs, and boot device. | ||
| Query the BMS NIC information, such as the IP address and MAC address of the NIC. | ||
| Attach EVS disks to or detach EVS disks from a BMS, and query EVS disks attached to a BMS. | ||
| The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. You can update the BMS metadata. | ||
| Query the quotas of all resources of a specified tenant, including used quotas. | ||
| Query whether one-click password reset is supported. If yes, you can reset the BMS password. Obtain and delete the password of a Windows BMS. | ||
| After a task, such as creating a BMS or attaching disks, is delivered, job_id is returned, based on which you can query the execution status of the task. | ||
| Native OpenStack v2.1 APIs | Query BMS details, query BMSs, and query details about BMSs. | |
| Start, restart, and stop BMSs. | ||
| The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. You can query, update, and delete BMS metadata. | ||
| Query the private IP address of a BMS, including the IP address version (IPv4 or IPv6) and the specific IP address. | ||
| ||
| Query all NICs of a BMS or query details about a NIC based on the NIC ID, such as the IP address and MAC address of the NIC. | ||
| Query all EVS disks attached to a BMS or query details about an EVS disk attached to a BMS based on the disk ID, such as the mount directory. | ||
| Query SSH key pairs or details about an SSH key pair, and create and delete SSH key pairs. | ||
| Add, delete, modify, and query 1D tags of BMSs. |
- When using BMS APIs, you must use the endpoints of the BMS service.
- When using native OpenStack APIs, you must use the endpoints registered by the ECS service.
- In the current version, long HTTP connections cannot be used to call native OpenStack APIs.
BMS API Constraints
| Type | API | URI | Constraint |
|---|---|---|---|
| API version query | GET / | 2000 times per minute | |
| GET /{api_version} | 2000 times per minute | ||
| Lifecycle management | POST /v1/{project_id}/baremetalservers | 50 times per minute | |
| GET /v1/{project_id}/baremetalservers/detail | 500 times per minute | ||
| GET /v1/{project_id}/baremetalservers/{server_id} | 1000 times per minute | ||
| Status management | PUT /v1/{project_id}/baremetalservers/{server_id} | 100 times per minute | |
| POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos | 50 times per minute | ||
| POST /v1/{project_id}/baremetalservers/action | 50 times per minute | ||
| POST /v1/{project_id}/baremetalservers/action | 50 times per minute | ||
| POST /v1/{project_id}/baremetalservers/action | 50 times per minute | ||
| Flavor management | GET /v1/{project_id}/baremetalservers/flavors | 500 times per minute | |
| NIC management | GET /v1/{project_id}/baremetalservers/{server_id}/os-interface | 500 times per minute | |
| EVS disk management | POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume | 100 times per minute | |
| DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} | 100 times per minute | ||
| GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments | 500 times per minute | ||
| Metadata management | POST /v1/{project_id}/baremetalservers/{server_id}/metadata | 100 times per minute | |
| Tenant quota management | GET /v1/{project_id}/baremetalservers/limits | 500 times per minute | |
| Password management | GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag | 500 times per minute | |
| PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password | 50 times per minute | ||
| GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 50 times per minute | ||
| DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password | 50 times per minute | ||
| Task management | GET /v1/{project_id}/jobs/{jobId} | 2000 times per minute |
Last Article: Selecting an API Type
Next Article: Calling APIs
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.