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

• Product Introduction

  • What Is a Bare Metal Server?

  • AZ

  • Storage

  • Network

    • VPC

    • High-Speed Network

    • User-defined VLAN

    • IB Network

    • User-defined Network

  • Security

    • Licenses Type

    • Cloud-Init

    • Project

  • Image

  • Flavor

  • Application Scenarios

  • What Advantages Does the BMS Service Have?

  • Accessing and Using BMSs

    • Accessing BMSs

    • Related Services

• Getting Started

  • Allocating a BMS

  • Logging In to a Linux BMS

    • Login Methods

    • Login Using an SSH Key

    • Login Using an SSH Password

    • Remote Login

  • Logging In to a Windows BMS

    • Login Methods

    • Login Using an MSTSC Password

  • Initializing Data Disks

• Instance

  • Lifecycle Management

    • Viewing the BMS Allocation Status

    • Querying BMS Details

    • Performing Lifecycle Management Operations on a BMS

  • Rebuilding a BMS

  • (Optional) Injecting User Data into BMSs

  • Metadata

  • Quota Management

• Storage

  • Attaching a Disk

  • Detaching a Disk

  • Expanding Disk Capacity

• Key Pair and Password

  • Creating a Key Pair

  • Deleting the Password of a Windows BMS

• Network

  • BMS Service Networks

    • Network Architecture

    • VPC

    • High-Speed Network

    • User-defined VLAN

    • IB Network

  • Managing an EIP

  • Configuring the Security Group

  • Changing a Security Group

  • Managing Virtual IP Addresses

  • Setting the Source/Destination Check for a NIC

  • Managing High-Speed Networks

  • Managing User-defined Networks

  • Configuring User-defined VLANs

    • Configuration Notes

    • SUSE Linux Enterprise Server 12

    • SUSE Linux Enterprise Server 11

    • Red Hat, CentOS, Oracle Linux, and EulerOS

    • Ubuntu

    • Windows Server

  • 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

• Image

  • Creating a Private Image

  • Exporting a Private Image

  • Registering a Private Image

• Software

  • Installing the NVIDIA GPU Driver and CUDA Toolkit

• Monitoring

  • (Optional) Configuring In-Band Monitoring for a BMS

  • BMS Metrics

• Auditing

  • Overview

  • BMS Operations Recorded by CTS

  • Viewing Traces

• 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.exe 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 Use Restrictions of BMSs?

    • How Are BMSs Different from ECSs?

    • What Are the Differences Between BMSs and Physical Servers?

    • What Functions Does the Delete Button Provide?

    • How Long Does It Take to Create a BMS?

    • Why Is Failed Displayed for a BMS Allocation Task But the BMS List Shows the Allocated BMS?

    • How Can I Check the BMS In-Band Monitoring Status?

  • Login FAQs

    • What Browser Version Is Required 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 Intranet?

    • Are My BMSs in the Same Subnet?

    • Can BMSs Communicate with ECSs in the Same VPC?

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

    • Can Multiple EIPs Be Bound to a BMS?

  • Disk FAQs

    • Can EVS Disks Be Attached to BMSs?

    • 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 Can 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 Configure a SID for a Windows Server 2012 BMS?

• Glossary

• Change History

Documents Download

Video Tutorial