文档中心知识库安全 API Explorer

文档中心›ZStack Cloud›API使用规范

ZCF

文档目录

ZStack Cloud 文档

文档版本

版本特性

产品手册

技术白皮书

安全白皮书

CLI命令使用手册

CTL命令使用手册

开发手册

API使用规范

SDK使用规范

使用AK调用API

裸金属管理(Plus)

弹性裸金属管理(Plus)

创建块存储卷(CreateBlockVolume)

添加存储协议(AddStorageProtocol)

获取访问路径列表(GetAccessPath)

更新xsky类型的块存储卷(UpdateXskyBlockVolume)

查询xsky类型块存储卷(QueryXskyBlockVolume)

查询expon类型块存储卷(QueryExponBlockVolume)

删除裸金属节点(DeleteBareMetal2Chassis)

更新裸金属节点信息(UpdateBareMetal2Chassis)

查询裸金属节点上的GPU设备(QueryBareMetal2ChassisGpuDevice)

查询裸金属节点上的PCI设备(QueryBareMetal2ChassisPciDevice)

获取裸金属节点BIOS启动模式(GetBareMetal2SupportedBootMode)

查询裸金属节点(QueryBareMetal2Chassis)

获取裸金属节点硬件信息(InspectBareMetal2Chassis)

启动裸金属节点(PowerOnBareMetal2Chassis)

关闭裸金属节点(PowerOffBareMetal2Chassis)

重启裸金属节点(PowerResetBareMetal2Chassis)

获取裸金属节点电源状态(GetBareMetal2ChassisPowerStatus)

更改裸金属节点启用状态(ChangeBareMetal2ChassisState)

使用IPMI地址单个添加裸金属节点(AddBareMetal2IpmiChassis)

使用IPMI地址范围批量添加裸金属节点(BatchAddBareMetal2IpmiChassis)

更新裸金属节点IPMI信息(UpdateBareMetal2IpmiChassis)

检查批量添加裸金属节点文件(CheckBareMetal2IpmiChassisConfigFile)

创建裸金属节点硬件信息(CreateBareMetal2IpmiChassisHardwareInfo)

更新裸金属节点规格(UpdateBareMetal2ChassisOffering)

查询裸金属节点规格(QueryBareMetal2ChassisOffering)

更改裸金属节点规格启用状态(ChangeBareMetal2ChassisOfferingState)

添加网关节点(AddBareMetal2Gateway)

删除网关节点(DeleteBareMetal2Gateway)

更新网关节点(UpdateBareMetal2Gateway)

查询网关节点(QueryBareMetal2Gateway)

更改网关节点启用状态(ChangeBareMetal2GatewayState)

重连网关节点(ReconnectBareMetal2Gateway)

获取网关节点分配策略(GetBareMetal2GatewayAllocatorStrategies)

将网关节点加载到弹性裸金属集群(AttachBareMetal2GatewayToCluster)

将网关节点从弹性裸金属集群卸载(DetachBareMetal2GatewayFromCluster)

为网关节点更改弹性裸金属集群(ChangeBareMetal2GatewayCluster)

创建裸金属实例(CreateBareMetal2Instance)

更新弹性裸金属实例(UpdateBareMetal2Instance)

查询弹性裸金属实例(QueryBareMetal2Instance)

修改弹性裸金属实例密码(ChangeBareMetal2InstancePassword)

启动弹性裸金属实例(StartBareMetal2Instance)

重连弹性裸金属实例(ReconnectBareMetal2Instance)

检查部署IP是否可用(CheckStaticProvisionIp)

通过弹性裸金属实例获取硬件信息(InspectBareMetal2ChassisByInstance)

创建裸金属实例Bond配置(CreateBareMetal2Bonding)

清理裸金属实例Bond信息(CleanUpBareMetal2Bonding)

查询裸金属实例的bond网络配置(QueryBareMetal2Bonding)

查询Bond和实例网卡的关联(QueryBareMetal2BondingNicRef)

创建部署网络(CreateBareMetal2ProvisionNetwork)

删除部署网络(DeleteBareMetal2ProvisionNetwork)

更新部署网络(UpdateBareMetal2ProvisionNetwork)

查询部署网络(QueryBareMetal2ProvisionNetwork)

更改部署网络启用状态(ChangeBareMetal2ProvisionNetworkState)

将部署网络加载到弹性裸金属集群(AttachBareMetal2ProvisionNetworkToCluster)

将部署网络从弹性裸金属集群卸载(DetachBareMetal2ProvisionNetworkFromCluster)

获取部署网络IP地址可用量(GetBareMetal2ProvisionNetworkIpAddressCapacity)

从实例备份数据新建弹性裸金属实例(CreateBareMetal2InstanceFromVmBackup)

从云盘备份数据新建弹性裸金属实例(CreateBareMetal2InstanceFromVolumeBackup)

VMware管理(Plus)

实践教程

快速安装使用教程（新手快速入门）

许可（license) 更新说明

多管理节点物理机高可用教程

物理机网络部署教程

普通用户（非Root用户）云平台快速部署教程

租户管理使用教程

灾备服务使用教程

持续数据保护（CDP）使用教程

弹性裸金属管理使用教程

裸金属管理使用教程

VMware管理使用教程

阿里云混合云管理使用教程

专有网络（VPC）使用教程

扁平网络使用教程

SDN使用教程

SR-IOV网卡虚拟化使用教程

GPU设备透传使用教程

vGPU虚拟化使用教程

USB设备透传使用教程

块设备透传使用教程

CentOS 6系统模板封装教程

CentOS 7系统模板封装教程

CentOS 8系统模板封装教程

CentOS Stream 9 系统模板封装教程

CentOS Stream 10 系统模板封装教程

Ubuntu 22系统模板封装教程

Rocky 8系统模板封装教程

Rocky 9系统模板封装教程

Rocky 10 系统模板封装教程

OpenEuler 24系统模板封装教程

Debian 13系统模板封装教程

Kylin 系统模板封装教程

Windows XP系统模板封装教程（GuestTools）

Windows Server 2003 R2系统模板封装教程（GuestTools）

Windows Server 2008 R2 ~ 2019系统模板封装教程（GuestTools）

Windows 10 系统模板封装教程

Shared Block 共享块存储（FC）部署教程

Shared Block 共享块存储（iSCSI）部署教程

HTTPS方式登录UI使用教程

云主机高可用实践教程

云主机调度策略使用教程

弹性伸缩使用教程

资源编排使用教程

云主机vNUMA配置教程

云主机控制台SPICE协议使用教程

磁盘快照使用教程

网络QoS&磁盘QoS使用教程

监控报警功能使用教程

SNMP管理使用教程

计费功能使用教程

账户管理使用教程

日志服务器配置教程

自定义主题外观配置教程

应用市场开发使用教程

云平台管理规范指南

操作系统修复指南

弹性裸金属管理(Plus)

58 个主题

创建块存储卷CreateBlockVolume按指定配置新建块存储卷。
添加存储协议AddStorageProtocol配置块存储使用的存储访问协议。
获取访问路径列表GetAccessPath列出可用于访问块存储的路径信息。
更新xsky类型的块存储卷UpdateXskyBlockVolume修改现有XSKY块存储卷的配置信息。
查询xsky类型块存储卷QueryXskyBlockVolume按条件检索xsky类型块存储卷，返回匹配记录。
查询expon类型块存储卷QueryExponBlockVolume按条件检索expon类型块存储卷，返回匹配记录。
删除裸金属节点DeleteBareMetal2Chassis将指定裸金属节点从云平台中移除。
更新裸金属节点信息UpdateBareMetal2Chassis调整裸金属节点的配置信息。
查询裸金属节点上的GPU设备QueryBareMetal2ChassisGpuDevice按条件检索裸金属节点上的GPU设备，返回匹配记录。
查询裸金属节点上的PCI设备QueryBareMetal2ChassisPciDevice按条件检索裸金属节点上的PCI设备，返回匹配记录。
获取裸金属节点BIOS启动模式GetBareMetal2SupportedBootMode列出裸金属节点可使用的BIOS启动模式。
查询裸金属节点QueryBareMetal2Chassis按条件检索裸金属节点，返回匹配记录。
获取裸金属节点硬件信息InspectBareMetal2Chassis向裸金属节点下发硬件信息采集请求。
启动裸金属节点PowerOnBareMetal2Chassis接通指定裸金属物理节点的电源。
关闭裸金属节点PowerOffBareMetal2Chassis关闭指定裸金属物理节点的电源。
重启裸金属节点PowerResetBareMetal2Chassis重置裸金属物理节点的电源以重新启动。
获取裸金属节点电源状态GetBareMetal2ChassisPowerStatus读取裸金属物理节点当前的电源状态。
更改裸金属节点启用状态ChangeBareMetal2ChassisState启用或停用指定的裸金属节点。
使用IPMI地址单个添加裸金属节点AddBareMetal2IpmiChassis通过单个IPMI地址接入裸金属节点。
使用IPMI地址范围批量添加裸金属节点BatchAddBareMetal2IpmiChassis按IPMI地址范围批量接入裸金属节点。
更新裸金属节点IPMI信息UpdateBareMetal2IpmiChassis调整裸金属节点IPMI的配置信息。
检查批量添加裸金属节点文件CheckBareMetal2IpmiChassisConfigFile校验用于批量导入裸金属节点的配置文件。
创建裸金属节点硬件信息CreateBareMetal2IpmiChassisHardwareInfo按指定配置新建裸金属节点硬件信息。
更新裸金属节点规格UpdateBareMetal2ChassisOffering调整裸金属节点规格的配置信息。
查询裸金属节点规格QueryBareMetal2ChassisOffering按条件检索裸金属节点规格，返回匹配记录。
更改裸金属节点规格启用状态ChangeBareMetal2ChassisOfferingState控制裸金属节点规格是否可用。
添加网关节点AddBareMetal2Gateway接入负责弹性裸金属流量转发的网关节点。
删除网关节点DeleteBareMetal2Gateway将指定裸金属网关节点从平台中移除。
更新网关节点UpdateBareMetal2Gateway调整网关节点的配置信息。
查询网关节点QueryBareMetal2Gateway按条件检索网关节点，返回匹配记录。
更改网关节点启用状态ChangeBareMetal2GatewayState启用或停用弹性裸金属网关节点。
重连网关节点ReconnectBareMetal2Gateway重新建立平台与裸金属网关节点的连接。
获取网关节点分配策略GetBareMetal2GatewayAllocatorStrategies列出弹性裸金属网关可使用的分配策略。
将网关节点加载到弹性裸金属集群AttachBareMetal2GatewayToCluster为弹性裸金属集群关联负责流量转发的网关。
将网关节点从弹性裸金属集群卸载DetachBareMetal2GatewayFromCluster解除弹性裸金属集群与指定网关节点的关联。
为网关节点更改弹性裸金属集群ChangeBareMetal2GatewayCluster调整网关节点所属的弹性裸金属集群。
创建裸金属实例CreateBareMetal2Instance按指定配置新建裸金属实例。
更新弹性裸金属实例UpdateBareMetal2Instance调整弹性裸金属实例的配置信息。
查询弹性裸金属实例QueryBareMetal2Instance按条件检索弹性裸金属实例，返回匹配记录。
修改弹性裸金属实例密码ChangeBareMetal2InstancePassword更新弹性裸金属实例使用的登录密码。
启动弹性裸金属实例StartBareMetal2Instance使指定弹性裸金属实例开始运行。
重连弹性裸金属实例ReconnectBareMetal2Instance重新建立平台与弹性裸金属实例的连接。
检查部署IP是否可用CheckStaticProvisionIp确认计划分配的部署网络IP地址是否可用。
通过弹性裸金属实例获取硬件信息InspectBareMetal2ChassisByInstance通过弹性裸金属实例查询底层节点硬件信息。
创建裸金属实例Bond配置CreateBareMetal2Bonding按指定配置新建裸金属实例Bond配置。
清理裸金属实例Bond信息CleanUpBareMetal2Bonding移除弹性裸金属实例保留的Bond网络信息。
查询裸金属实例的bond网络配置QueryBareMetal2Bonding按条件检索弹性裸金属实例的Bond网络配置。
查询Bond和实例网卡的关联QueryBareMetal2BondingNicRef按条件检索Bond和实例网卡的关联，返回匹配记录。
创建部署网络CreateBareMetal2ProvisionNetwork新建用于裸金属节点启动与镜像下载的部署网络。
删除部署网络DeleteBareMetal2ProvisionNetwork移除裸金属节点使用的部署网络配置。
更新部署网络UpdateBareMetal2ProvisionNetwork调整部署网络的配置信息。
查询部署网络QueryBareMetal2ProvisionNetwork按条件检索部署网络，返回匹配记录。
更改部署网络启用状态ChangeBareMetal2ProvisionNetworkState启用或停用裸金属节点的部署网络。
将部署网络加载到弹性裸金属集群AttachBareMetal2ProvisionNetworkToCluster为弹性裸金属集群关联系统部署网络。
将部署网络从弹性裸金属集群卸载DetachBareMetal2ProvisionNetworkFromCluster解除弹性裸金属集群与部署网络的关联。
获取部署网络IP地址可用量GetBareMetal2ProvisionNetworkIpAddressCapacity统计部署网络尚可分配的IP地址数量。
从实例备份数据新建弹性裸金属实例CreateBareMetal2InstanceFromVmBackup利用已有实例备份恢复出新的弹性裸金属实例。
从云盘备份数据新建弹性裸金属实例CreateBareMetal2InstanceFromVolumeBackup利用已有云盘备份恢复出新的弹性裸金属实例。

上一篇裸金属管理(Plus)下一篇创建块存储卷(CreateBlockVolume)

本页目录

弹性裸金属管理(Plus)

ZStack © 2015-2026 上海云轴科技股份有限公司保留所有权利

法律声明隐私政策用户管理规则及公约

文档中心知识库安全 API Explorer

ZH/EN