Help Center/ Bare Metal Server/ API Reference (Paris Region)/ API Overview

Updated on 2022-02-22 GMT+08:00

View PDF

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.

**Table 1** API description
Type	Subtype	Description
BMS APIs	Lifecycle management	View BMS details.
	Status management	Change the name of a BMS.
	EVS disk management	Attach EVS disks to and detach EVS disks from BMSs.
	Task status query	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	Lifecycle management	Create a BMS, delete a BMS, query BMS details, query BMSs, and query details about BMSs.
	Status management	Start, restart, and stop BMSs.
	Metadata management	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.
	IP address query	Query the private IP address of a BMS, including the IP address version (IPv4 or IPv6) and the specific IP address.
	BMS flavor query	Querying BMS Flavors: Query all BMS flavors or query specified BMS flavors by filters. Querying BMS Flavor Details: Query details about a BMS based on the flavor ID, such as the flavor name, number of CPUs, and memory. Querying Parameter extra_specs of a BMS Flavor: Parameter extra_specs specifies the key-value pair of a BMS flavor. If you want to check whether a BMS flavor supports quick provisioning, call this API.
	BMS NIC query	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.
	EVS disk management	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 and EVS disk ID.
	SSH key management	Query SSH key pairs or details about an SSH key pair, and create and delete SSH key pairs.
	1D tag management	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

**Table 2** BMS API constraints
Type	API	URI	Constraint
Lifecycle management	Querying Details About a BMS	GET /v1/{project_id}/baremetalservers/{server_id}	600 times per minute
Status management	Changing the Name of a BMS	PUT /v1/{project_id}/baremetalservers/{server_id}	100 times per minute
Disk management	Attaching an EVS Disk to a BMS	POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume	100 times per minute
Disk management	Detaching an EVS Disk from a BMS	DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id}	100 times per minute
Task management	Querying the Task Status	GET /v1/{project_id}/jobs/{jobId}	2000 times per minute

Previous topic: Selecting an API Type

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.