Docs Knowledge Base Security API Explorer

Documentation›ZStack Cloud›RESTful API Overview

ZCF

Document navigation

ZStack Cloud Docs

Documentation version

Release features

Feature Overview

Product manuals

Technical Whitepaper

Security Whitepaper

Maintenance Manual

CLI Command Manual

CTL Command Manual

Development manuals

RESTful API Overview

API Call with AccessKey

CloudFormation Operations

Bare Metal Management (Plus)

Elastic Bare Metal Management(Plus)

CreateBlockVolume

AddStorageProtocol

UpdateXskyBlockVolume

QueryXskyBlockVolume

QueryExponBlockVolume

DeleteBareMetal2Chassis

UpdateBareMetal2Chassis

QueryBareMetal2ChassisGpuDevice

QueryBareMetal2ChassisPciDevice

GetBareMetal2SupportedBootMode

QueryBareMetal2Chassis

InspectBareMetal2Chassis

PowerOnBareMetal2Chassis

PowerOffBareMetal2Chassis

PowerResetBareMetal2Chassis

GetBareMetal2ChassisPowerStatus

ChangeBareMetal2ChassisState

AddBareMetal2IpmiChassis

BatchAddBareMetal2IpmiChassis

UpdateBareMetal2IpmiChassis

CheckBareMetal2IpmiChassisConfigFile

CreateBareMetal2IpmiChassisHardwareInfo

UpdateBareMetal2ChassisOffering

QueryBareMetal2ChassisOffering

ChangeBareMetal2ChassisOfferingState

AddBareMetal2Gateway

DeleteBareMetal2Gateway

UpdateBareMetal2Gateway

QueryBareMetal2Gateway

ChangeBareMetal2GatewayState

ReconnectBareMetal2Gateway

GetBareMetal2GatewayAllocatorStrategies

AttachBareMetal2GatewayToCluster

DetachBareMetal2GatewayFromCluster

ChangeBareMetal2GatewayCluster

CreateBareMetal2Instance

UpdateBareMetal2Instance

QueryBareMetal2Instance

ChangeBareMetal2InstancePassword

StartBareMetal2Instance

ReconnectBareMetal2Instance

CheckStaticProvisionIp

InspectBareMetal2ChassisByInstance

CreateBareMetal2Bonding

CleanUpBareMetal2Bonding

QueryBareMetal2Bonding

QueryBareMetal2BondingNicRef

CreateBareMetal2ProvisionNetwork

DeleteBareMetal2ProvisionNetwork

UpdateBareMetal2ProvisionNetwork

QueryBareMetal2ProvisionNetwork

ChangeBareMetal2ProvisionNetworkState

AttachBareMetal2ProvisionNetworkToCluster

DetachBareMetal2ProvisionNetworkFromCluster

GetBareMetal2ProvisionNetworkIpAddressCapacity

CreateBareMetal2InstanceFromVmBackup

CreateBareMetal2InstanceFromVolumeBackup

Practical tutorials

Quick Installation and Usage Tutorial

Upgrade Tutorial

License Update Guide

Dual-MN HA Tutorial

Host Network Configuration Tutorial

Tenant Management Tutorial

Backup Service Tutorial

Continuous Data Protection (CDP) Module Tutorial

VMware Management Tutorial

Alibaba Cloud Hybrid Cloud Management Tutorial

VPC Network Tutorial

Flat Network Tutorial

SR-IOV NIC Virtualization Tutorial

GPU Passthrough Tutorial

GPU Virtualization Tutorial

USB Passthrough Tutorial

CentOS 8 Template Tutorial

CentOS Stream 9 Template Tutorial

CentOS Stream 10 Template Tutorial

Rocky Linux 9 Template Tutorial

Rocky Linux 10 Template Tutorial

openEuler 24 System Template Tutorial

Debian 13 System Template Tutorial

System Template Creation Tutorial

Windows Server Template Tutorial 2008 R2~2019 (GuestTools)

Windows 10 System Template Tutorial (GuestTools)

SharedBlock Storage Deployment Tutorial (FC Storage)

SharedBlock Storage Deployment Tutorial (iSCSI Storage)

UI Login Through HTTPS Tutorial

VM Scheduling Policy Tutorial

Network QoS & Disk QoS Tutorial

SNMP Management Tutorial

Account Management Tutorial

Log Server Configuration Tutorial

Theme & Appearance Customization Tutorial

Application Market Development and Using Tutorial

Elastic Bare Metal Management(Plus)

58 topics

List storage access pathsGetAccessPathList the access paths available for storage access.
Create a block storage volumeCreateBlockVolumeCreate a new block storage volume using the specified configuration.
Add a storage protocolAddStorageProtocolAdd a storage protocol configuration to the platform.
Update XSKY block storage volumeUpdateXskyBlockVolumeUpdate the configuration of the specified XSKY block storage volume.
Query XSKY block storage volumesQueryXskyBlockVolumeFind XSKY block storage volumes matching the specified query conditions.
Query Expon block storage volumesQueryExponBlockVolumeFind Expon block storage volumes matching the specified query conditions.
Delete baremetal nodeDeleteBareMetal2ChassisDelete the specified baremetal node from the platform.
Update baremetal nodeUpdateBareMetal2ChassisUpdate the configuration of the specified baremetal node.
List baremetal node GPU devicesQueryBareMetal2ChassisGpuDeviceFind GPU devices installed on baremetal nodes.
List baremetal node PCI devicesQueryBareMetal2ChassisPciDeviceFind PCI devices installed on baremetal nodes.
View supported baremetal boot modesGetBareMetal2SupportedBootModeList BIOS boot modes supported by a baremetal node.
Query baremetal nodesQueryBareMetal2ChassisFind baremetal nodes matching the specified query conditions.
Inspect baremetal node hardwareInspectBareMetal2ChassisRequest hardware information from a baremetal node.
Power on the physical baremetal nodePowerOnBareMetal2ChassisPower on the specified physical baremetal node.
Power off the physical baremetal nodePowerOffBareMetal2ChassisPower off the specified physical baremetal node.
Reset the power of the baremetal nodePowerResetBareMetal2ChassisReset the power of the specified baremetal node.
View baremetal node power stateGetBareMetal2ChassisPowerStatusRead the current power state of a baremetal node.
Enable or disable the baremetal nodeChangeBareMetal2ChassisStateEnable or disable the specified baremetal node.
Add a baremetal node through IPMIAddBareMetal2IpmiChassisAdd a baremetal node using its IPMI address.
Import baremetal nodes by IPMI rangeBatchAddBareMetal2IpmiChassisAdd baremetal nodes in bulk using an IPMI address range.
Update baremetal node IPMI configurationUpdateBareMetal2IpmiChassisUpdate the configuration of the specified baremetal node IPMI configuration.
Validate a baremetal import fileCheckBareMetal2IpmiChassisConfigFileValidate a configuration file for importing baremetal nodes.
Create a baremetal node hardware recordCreateBareMetal2IpmiChassisHardwareInfoCreate a new baremetal node hardware record using the specified configuration.
Update baremetal node offeringUpdateBareMetal2ChassisOfferingUpdate the configuration of the specified baremetal node offering.
Query baremetal node offeringsQueryBareMetal2ChassisOfferingFind baremetal node offerings matching the specified query conditions.
Enable or disable baremetal node offeringsChangeBareMetal2ChassisOfferingStateEnable or disable a baremetal node offering.
Add an elastic baremetal gatewayAddBareMetal2GatewayRegister a gateway node for elastic baremetal management.
Delete baremetal gateway nodeDeleteBareMetal2GatewayDelete the specified baremetal gateway node from the platform.
Update baremetal gateway nodeUpdateBareMetal2GatewayUpdate the configuration of the specified baremetal gateway node.
Query baremetal gateway nodesQueryBareMetal2GatewayFind baremetal gateway nodes matching the specified query conditions.
Enable or disable the baremetal gateway nodeChangeBareMetal2GatewayStateEnable or disable the specified baremetal gateway node.
Reconnect a baremetal gateway nodeReconnectBareMetal2GatewayReestablish the platform connection to a baremetal gateway node.
View baremetal gateway allocation strategiesGetBareMetal2GatewayAllocatorStrategiesList allocation strategies for elastic baremetal gateway nodes.
Attach an elastic baremetal gatewayAttachBareMetal2GatewayToClusterAttach a gateway node to an elastic baremetal cluster.
Detach an elastic baremetal gatewayDetachBareMetal2GatewayFromClusterDetach a gateway node from an elastic baremetal cluster.
Change an elastic baremetal gateway's clusterChangeBareMetal2GatewayClusterMove a gateway node to a different elastic baremetal cluster.
Create an elastic baremetal instanceCreateBareMetal2InstanceCreate a new elastic baremetal instance using the specified configuration.
Update elastic baremetal instanceUpdateBareMetal2InstanceUpdate the configuration of the specified elastic baremetal instance.
Query elastic baremetal instancesQueryBareMetal2InstanceFind elastic baremetal instances matching the specified query conditions.
Change the elastic baremetal instance passwordChangeBareMetal2InstancePasswordChange the login password of an elastic baremetal instance.
Start the elastic baremetal instanceStartBareMetal2InstanceStart the specified elastic baremetal instance through the platform.
Reconnect an elastic baremetal instanceReconnectBareMetal2InstanceReestablish the platform connection to an elastic baremetal instance.
Check a provision network IP addressCheckStaticProvisionIpCheck whether a provision network IP address is available.
Inspect a baremetal instance's hardwareInspectBareMetal2ChassisByInstanceRetrieve baremetal hardware information through an elastic baremetal instance.
Create a baremetal network bond configurationCreateBareMetal2BondingCreate a new baremetal network bond configuration using the specified configuration.
Clear elastic baremetal network bond informationCleanUpBareMetal2BondingClear network bond information for a baremetal instance.
Query baremetal network bond configurationsQueryBareMetal2BondingFind network bond configurations for elastic baremetal instances.
Query baremetal bond and NIC associationsQueryBareMetal2BondingNicRefFind associations between baremetal network bonds and instance NICs.
Create a baremetal provision networkCreateBareMetal2ProvisionNetworkCreate a new baremetal provision network using the specified configuration.
Delete baremetal provision networkDeleteBareMetal2ProvisionNetworkDelete the specified baremetal provision network from the platform.
Update baremetal provision networkUpdateBareMetal2ProvisionNetworkUpdate the configuration of the specified baremetal provision network.
Query baremetal provision networksQueryBareMetal2ProvisionNetworkFind baremetal provision networks matching the specified query conditions.
Enable or disable the baremetal provision networkChangeBareMetal2ProvisionNetworkStateEnable or disable the specified baremetal provision network.
Attach an elastic baremetal provision networkAttachBareMetal2ProvisionNetworkToClusterAttach a provision network to an elastic baremetal cluster.
Detach an elastic baremetal provision networkDetachBareMetal2ProvisionNetworkFromClusterDetach a provision network from an elastic baremetal cluster.
Check provision network IP capacityGetBareMetal2ProvisionNetworkIpAddressCapacityCheck available IP address capacity in a provision network.
Restore baremetal from an instance backupCreateBareMetal2InstanceFromVmBackupCreate an elastic baremetal instance from instance backup data.
Restore baremetal from a volume backupCreateBareMetal2InstanceFromVolumeBackupCreate an elastic baremetal instance from volume backup data.

PreviousBare Metal Management (Plus)NextGetAccessPath

On this page

Elastic Bare Metal Management(Plus)

Copyright © 2026 ZStack. All rights reserved.

Site Terms Privacy Policy User Management Rules

Docs Knowledge Base Security API Explorer

ZH/EN