API Reference

• API Usage Guidelines

• API

  • BMS API Usage Restrictions

  • API Version Query (Native OpenStack API)

    • Querying API Versions (Native OpenStack API)

    • Querying an API Version (Native OpenStack API)

  • BMS Lifecycle Management (Native OpenStack APIs)

    • Creating a BMS (Native OpenStack API)

    • Deleting a BMS (Native OpenStack API)

    • Querying Details About a BMS (Native OpenStack API)

    • Querying BMSs (Native OpenStack API)

    • Querying Details About BMSs (Native OpenStack API)

  • BMS Status Management (Native OpenStack APIs)

    • Modifying a BMS (Native OpenStack API)

    • Starting a BMS (Native OpenStack API)

    • Restarting a BMS (Native OpenStack API)

    • Stopping a BMS (Native OpenStack API)

    • Querying BMS Metadata (Native OpenStack API)

    • Updating BMS Metadata (Native OpenStack API)

    • Modifying Specified BMS Metadata (Native OpenStack API)

    • Deleting Specified BMS Metadata (Native OpenStack API)

  • BMS IP Address Query (Native OpenStack APIs)

    • Querying IP Addresses of BMSs (Native OpenStack API)

    • Querying the IP Address of a BMS (Native OpenStack API)

  • BMS Flavor Query (Native OpenStack APIs)

    • Querying BMS Flavors (Native OpenStack API)

    • Querying Details About a BMS Flavor (Native OpenStack API)

    • Querying Details About BMS Flavor extra_specs (Native OpenStack API)

  • BMS NIC Management (Native OpenStack APIs)

    • Querying Information About BMS NICs (Native OpenStack API)

    • Querying NIC Information About a Specified BMS (Native OpenStack API)

  • BMS Disk Management (Native OpenStack APIs)

    • Querying Information About the Disks Attached to a BMS (Native OpenStack API)

    • Querying Information About a Disk Attached to a BMS (Native OpenStack API)

    • Attaching an EVS Disk to a BMS (Native OpenStack API)

    • Detaching an EVS Disk from a BMS (Native OpenStack API)

  • BMS SSH Key Pair Management (Native OpenStack APIs)

    • Querying SSH Key Pairs (Native OpenStack API)

    • Querying an SSH Key Pair (Native OpenStack API)

    • Creating and Importing an SSH Key Pair (Native OpenStack API)

    • Deleting an SSH Key Pair (Native OpenStack API)

  • BMS 1D Tag Management (Native OpenStack APIs)

    • Querying BMS Tags (Native OpenStack API)

    • Adding Tags to a BMS (Native OpenStack API)

    • Deleting Tags of a BMS (Native OpenStack API)

    • Adding a Tag to a BMS (Native OpenStack API)

    • Checking for Tags of a BMS (Native OpenStack API)

    • Deleting a Tag of a BMS (Native OpenStack API)

• Return Codes

  • Common Returned Values

• Appendix

  • Network API Description

• Change History

Private Image Creation Guide (BMS)

• Overview

• Preparing the Environment

• Creating a Linux Image

  • Preparing Required Hardware and Software

  • Creating a VM

  • Installing an OS on the VM

    • Overview

    • SUSE 11 SP4

    • Ubuntu 16.04, Ubuntu 14.04, and Debian 8.6

    • SUSE 12

    • CentOS 7.4 for ARM

    • XenServer 7.1

  • Configuring the VM Environment

  • Installing Cloud-Init

    • Overview

    • Red Hat, CentOS, Oracle Linux, and XenServer

    • SUSE 11 SP4

    • SUSE 12

    • EulerOS 2.2 and EulerOS 2.3

    • Ubuntu 16.04

    • Ubuntu 14.04

    • Debian 8.6

  • Configuring Cloud-Init

    • Scenarios

    • Configuring Cloud-Init 0.7.5

    • Configuring Cloud-Init 0.7.6

    • Configuring Cloud-Init 0.7.9

    • Configuring Cloud-Init 17.1

    • Configuring Cloud-Init 18.2

  • Checking the Cloud-Init Status

    • SUSE 11 SP4

    • SUSE 12 SP1

    • SUSE 12 SP2, SUSE 12 SP3, Oracle Linux 7, Red Hat 7, CentOS 7, XenServer 7, and CentOS 7.4 for ARM

    • EulerOS 2.2 and EulerOS 2.3

    • Red Hat 6, CentOS 6, and Oracle Linux 6

    • Ubuntu 16.04

    • Ubuntu 14.04

  • Modifying the Hardware Device Driver That Boots the OS

  • Installing the bms-network-config Software Package

  • Installing the SDI Card Driver

  • Installing the Driver

    • Preparations

    • (Optional) Installing the IB NIC Driver

    • (Optional) Installing the V5 Server Driver

    • (Optional) Installing the mpt3 Disk Driver

    • (Optional) Installing the RAID Card Driver

  • (Optional) Installing the UltraPath

  • Performing Security Configurations

  • Configuring Remote Login to a BMS

    • Scenarios

    • Oracle Linux 7.3, Oracle Linux 7.4, Red Hat 7, CentOS 7.2, and CentOS 7.4

    • Oracle Linux 6, Red Hat 6, and CentOS 6

    • XenServer 7.1

    • SUSE 11 SP4

    • CentOS 7.4 for ARM

    • SUSE 12, CentOS 7.3, EulerOS 2.2, EulerOS 2.3, and Oracle Linux 7.2

    • EulerOS-ARM64 2.2

    • Ubuntu 16.04

    • Ubuntu 16.04 for ARM

    • Ubuntu 14.04 and Debian 8.6

  • Configuring the Root Partition to Automatically Expand Disk Capacity

    • Scenarios

    • CentOS 6 and Red Hat 6

    • CentOS 7 and Red Hat 7

    • EulerOS 2.2 and EulerOS 2.3

    • SUSE 11 SP4

    • Debian 8.6

  • Deleting Files

• Creating a Windows Image

  • Preparing Required Hardware and Software

  • Installing Drivers

    • Preparations

    • Installing the Chipset Driver

    • (Optional) Installing the V5 Server Driver

    • (Optional) Installing the 3408 RAID Card Driver

    • Generate the ISO Image

  • Creating a VM

  • Configuring the VM Environment

  • Installing Cloudbase-Init

    • Windows Server 2012 and Windows Server 2016

    • Windows Server 1709

  • Installing the bms-network-config Software Package

    • Windows Server 2012 and Windows Server 2016

    • Windows Server 1709

  • Installing the SDI Card Driver

  • Setting Time Zone Calibration

  • Setting Virtual Memory

  • (Optional) Enabling Automatic Windows Update

  • Configuring the SID

• Stopping the VM and Obtaining the Image

• Converting the Image Format

• FAQ

  • How Can I Set the Mode of Adjusting the BMS CPU Frequency?

  • How Can I Handle the Failure of Data Injection into the BMS Due to the Occasional Start Failure of cloud-init-local?

  • How Can I Activate a Windows BMS?

• Appendix

  • Configuring the SSH Service

  • Configuring the vsftpd Service

  • Configuring the VNC Service

• Change History

Developer Guide

• Overview

• Notes

• Creating a BMS

• Attaching an EVS Disk to a BMS

• Detaching an EVS Disk from a BMS

• Querying IP Addresses of BMSs

• Appendix

  • Common Returned Values

• Change History

User Guide

• Service Overview

  • What Is Bare Metal Server?

  • BMS Advantages

  • Application Scenarios

  • Instance

    • Instance Family

    • Lifecycle

  • Image

    • Overview

  • Disk

  • Network

  • Security

    • License Type

    • Security Group

    • Cloud-Init

    • Key Pair and Password

    • Access Control

  • Region and AZ

  • Related Services

• Getting Started

  • Quick Start

  • Making Preparations

  • Step 1: Create a BMS

  • Step 2: Log In to the BMS

  • Step 3: Deploy an Application

  • Step 4: Release the BMS

• Instance

  • Creating a BMS

    • Creating a BMS

    • Creating a BMS Supporting Quick Provisioning

    • Creating a BMS Using a Private Image

  • Viewing BMS Information

    • Viewing BMS Creation Statuses

    • Viewing BMS Details

  • Logging In to a BMS

    • Linux BMS Login Methods

    • Remotely Logging In to a BMS

    • Logging In to a BMS Using an SSH Key Pair

    • Logging In to a BMS Using a Password

  • IB Network

    • Windows BMS Login Methods

    • Logging In to a BMS Remotely Using MSTSC

  • Managing BMSs

    • Changing the Name of a BMS

    • Stopping BMSs

    • Restarting BMSs

    • Rebuilding a BMS

    • Provisioning a BMS

  • Managing User Data and Metadata

    • Injecting User Data into BMSs

    • Metadata

  • Installing Drivers and Toolkits

    • Installing the NVIDIA GPU Driver and CUDA Toolkit on a P1 BMS

    • Installing the NVIDIA GPU Driver and CUDA Toolkit on a P2 BMS

• Image

  • Private Image Overview

  • Creating a Private Image from a BMS

  • Creating a Private Image from an External Image File

  • Convert Image File Formats

• Disk

  • Attaching Data Disks

  • Initializing Data Disks

    • Introduction to Data Disk Initialization Scenarios and Partition Styles

    • Initializing a Windows Data Disk (Windows Server 2016)

    • Initializing a Linux Data Disk (fdisk)

    • Initializing a Linux Data Disk (parted)

  • Detaching Data Disks

  • Expanding Disk Capacity

• Key Pair and Password

  • Using a Key Pair

  • Obtaining the Password of a Windows BMS

  • Deleting the Password of a Windows BMS

• Network

  • EIP

    • Binding an EIP to a BMS

    • Unbinding an EIP from a BMS

  • VPC

    • Overview

    • Managing Virtual IP Addresses

    • Setting the Source/Destination Check for a NIC

  • High-Speed Network

    • Overview

    • Managing High-Speed Networks

  • User-defined VLAN

    • Overview

    • Configuring a User-defined VLAN (SUSE Linux Enterprise Server 12)

    • Configuring a User-defined VLAN (SUSE Linux Enterprise Server 11)

    • Configuring a User-defined VLAN (Red Hat, CentOS, Oracle Linux, and EulerOS)

    • Configuring a User-defined VLAN (Ubuntu)

    • Configuring a User-defined VLAN (Windows Server)

  • IB Network

    • Overview

  • User-defined Network

    • Overview

    • Creating and Managing a User-defined Network

• Security

  • Security Group

    • Adding Security Group Rules

    • Security Group Configuration Examples

    • Changing a Security Group

• Virtualization

  • Overview

  • XenServer on BMS

    • Solution Overview

    • Preparing for the Deployment

    • Allocating a BMS

    • Creating a User-defined Network

    • Configuring a VPC NIC for the BMS

    • Configuring the User-defined VLAN NIC for the BMS

    • Configuring the vNIC for the Service VM

    • (Optional) Creating a NAT Gateway and Adding a DNAT Rule

• Resource

  • Tag

    • Overview

    • Adding Tags

    • Searching for Resources by Tag

    • Deleting Tags

  • Adjusting Resource Quotas

• Server Monitoring

  • Installing and Configuring Agent

  • Supported Monitoring Metrics

• Auditing of Key Operations

  • Viewing Traces

  • BMS Operations Recorded by CTS

• Troubleshooting

  • What Can I Do If I Cannot Log In to My BMS or the BMS EVS Disk Is Lost After the BMS Is Started or Restarted?

  • What Should I Do If a Key Pair Created Using PuTTYgen Cannot Be Imported to the Management Console?

  • What Can I Do If Disks Cannot Be Attached to a BMS That Restarts Abnormally?

  • What Can I Do If an EVS Disk Attached to a Windows BMS Is in Offline State?

• FAQs

  • General FAQs

    • What Are the Restrictions on Using BMSs?

    • How Are BMSs Different from ECSs?

    • What Are the Differences Between BMSs and Traditional Physical Servers?

    • How Long Does It Take to Create a BMS?

    • Why Is Failed Displayed for a BMS Application Task But the BMS List Shows the Obtained BMS?

    • Is the BMS Host Name with Suffix novalocal Normal?

    • How Do I Create an Agency for Server Monitoring of the BMS?

    • How Can I Check the BMS Monitoring Status?

  • Login FAQs

    • What Browser Versions Can Be Used to Remotely Log In to a BMS?

    • What Can I Do If the Login Page Does Not Respond?

    • What Can I Do If the BMS Console Is Displayed Improperly After I Remotely Log In to a BMS?

  • Network and Security FAQs

    • Can BMSs of Different Accounts Communicate with Each Other over an Internal Network?

    • Are My BMSs in the Same Subnet?

    • Can BMSs Communicate with ECSs in the Same VPC?

    • Can Multiple EIPs Be Bound to a BMS?

    • How Can I Modify the Network Configuration or Restart the Network If I Can Log In to a BMS Using Only SSH?

    • What Should I Do If a Service Port Is Used by a One-Click Password Reset Plug-in?

    • What Can I Do If the Communication Between the Primary NIC and Extension NIC of the BMS is Abnormal?

    • How Can I Configure a Static IP Address for a BMS?

    • How Do I Configure the DNS Server?

  • Disk FAQs

    • Can EVS Disks Be Attached to BMSs?

    • How Do I Change the Disk Identifier in the fstab file to UUID?

    • What Are the Restrictions for Attaching a Disk to a BMS?

    • How Do I Obtain the Drive Letter of an EVS Disk?

    • Are the EVS Disk Device Names on the Console and the Device Names in BMS OSs Consistent?

    • How Can I Quickly Provision BMSs Using EVS Disks?

    • Why Is the EVS Disk Size Not Updated in the BMS OS After the EVS Disk Capacity Has Been Expanded?

    • How Can I Restore System Disk Data Using the Snapshot?

    • What Can I Do to Prevent Risks of Attaching or Detaching the System Disk?

    • How Should I Select Storage?

    • Why Is the Disk Capacity Displayed in the BMS OS Less Than That Displayed on the Official Website?

  • OS FAQs

    • Can I Install or Upgrade BMS OSs by Myself?

    • Can the BMS OS Be Replaced?

    • Is a GUI Provided for BMS OSs?

    • Is an Upload Tool Delivered with BMS OSs?

    • How Do I Configure the Static Host Name of a BMS?

    • How Do I Set the Password Validity Period?

    • How Should I Set SSH Configuration Items?

    • How Can I Handle the Eight-Hour Difference Between the Windows BMS and Local Time

    • How Can I Activate a Windows BMS?

    • How Do I Change the SID of a Windows Server 2012 BMS?

    • How Do I Reserve Log Space If the Root Partition Automatically Expands Disks?

    • How Do I Roll Back the Kernel Version If I Mistakenly Upgrade the Kernel?

    • How Do I Increase the Swap Partition Size?

  • Virtualization

    • How Do I Access VMs on a BMS with KVM Deployed from the Internet?

• Glossary

• Change History

Documents Download

Video Tutorial