Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

API Overview

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

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

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.

NOTE:
  • 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

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

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback