文档中心知识库安全 API Explorer

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

ZCF

文档目录

ZStack Cloud 文档

文档版本

版本特性

产品手册

技术白皮书

安全白皮书

CLI命令使用手册

CTL命令使用手册

开发手册

API使用规范

SDK使用规范

使用AK调用API

云主机相关接口

创建云主机(CreateVmInstance)

从云盘创建云主机(CreateVmInstanceFromVolume)

从快照创建云主机(CreateVmInstanceFromVolumeSnapshot)

从快照组创建云主机(CreateVmInstanceFromVolumeSnapshotGroup)

从OVF模板导入云主机(CreateVmInstanceFromOvf)

导出云主机的OVA包(ExportVmOvaPackage)

解析OVF模板信息(ParseOvf)

删除云主机(DestroyVmInstance)

恢复已删除云主机(RecoverVmInstance)

彻底删除云主机(ExpungeVmInstance)

查询云主机(QueryVmInstance)

启动云主机(StartVmInstance)

停止云主机(StopVmInstance)

重启云主机(RebootVmInstance)

暂停云主机(PauseVmInstance)

恢复暂停的云主机(ResumeVmInstance)

重置云主机(ReimageVmInstance)

创建资源分组目录(CreateDirectory)

删除资源分组目录(DeleteDirectory)

添加资源至分组目录(AddResourcesToDirectory)

移动资源至分组目录(MoveResourcesToDirectory)

从分组目录移除资源(RemoveResourcesFromDirectory)

更新分组目录(UpdateDirectory)

查询分组目录(QueryDirectory)

热迁移云主机(MigrateVm)

查询共享磁盘所挂载的云主机(QueryShareableVolumeVmInstanceRef)

获取可热迁移的物理机列表(GetVmMigrationCandidateHosts)

获取创建云主机时可选择的主存储(GetCandidatePrimaryStoragesForCreatingVm)

获取云主机可加载ISO列表(GetCandidateIsoForAttachingVm)

获取ISO可加载云主机列表(GetCandidateVmForAttachingIso)

加载ISO到云主机(AttachIsoToVmInstance)

卸载云主机上的ISO(DetachIsoFromVmInstance)

获取云主机可加载云盘列表(GetVmAttachableDataVolume)

获取云主机可加载L3网络列表(GetVmAttachableL3Network)

获取资源虚拟化软件信息(GetVirtualizerInfo)

加载L3网络到云主机(AttachL3NetworkToVm)

从云主机卸载网络(DetachL3NetworkFromVm)

创建云主机网卡(CreateVmNic)

修改云主机网卡状态 (ChangeVmNicState)

加载网卡到云主机(AttachVmNicToVm)

删除云主机网卡(DeleteVmNic)

更改网卡的默认流量策略(ChangeVmNicSecurityPolicy)

查询云主机网卡(QueryVmNic)

获取网卡加载的网络服务名称(GetVmNicAttachedNetworkService)

修改云主机网卡三层网络(ChangeVmNicNetwork)

获取云主机网卡可挂载的三层网络(GetCandidateL3NetworksForChangeVmNicNetwork)

设置云主机网卡限速(SetNicQos)

获取云主机网卡限速(GetNicQos)

取消云主机网卡限速(DeleteNicQos)

获取相互依赖的镜像和L3网络(GetInterdependentL3NetworksImages)

设置云主机SSH Key (SetVmSshKey)

获取云主机SSH Key (GetVmSshKey)

删除云主机SSH Key(DeleteVmSshKey)

变更云主机密码(ChangeVmPassword)

设置云主机控制台密码(SetVmConsolePassword)

删除云主机控制台密码(DeleteVmConsolePassword)

获取云主机控制台密码(GetVmConsolePassword)

更新云主机控制台密码(UpdateConsolePassword)

获取云主机控制台地址和访问协议(GetVmConsoleAddress)

设置云主机Hostname(SetVmHostname)

获取云主机Hostname(GetVmHostname)

删除云主机Hostname(DeleteVmHostname)

创建启动云主机的定时任务(CreateStartVmInstanceScheduler)

创建停止云主机的定时任务(CreateStopVmInstanceScheduler)

创建重启云主机的定时任务(CreateRebootVmInstanceScheduler)

获取云主机启动设备列表(GetVmBootOrder)

指定云主机启动设备(SetVmBootOrder)

获取目的地列表(GetCandidateZonesClustersHostsForCreatingVm)

获取云主机可启动目的地列表(GetVmStartingCandidateClustersHosts)

指定云主机IP(SetVmStaticIp)

删除云主机指定IP(DeleteVmStaticIp)

获取云主机能力(GetVmCapabilities)

更新云主机信息(UpdateVmInstance)

克隆云主机(CloneVmInstance)

设置云主机时钟同步（SetVmClockTrack）

立即同步云主机时钟（SyncVmClock）

设置云主机高可用级别(SetVmInstanceHaLevel)

获取云主机高可用级别(GetVmInstanceHaLevel)

取消云主机高可用(DeleteVmInstanceHaLevel)

获取云主机Qga (GetVmQga)

设置云主机Qga (SetVmQga)

获取云主机GuestTools状态 (QueryGuestToolsState)

更新云主机GuestTools状态(UpdateGuestToolsState)

同步云主机网络配置(UpdateVmNetworkConfig)

获取云主机RDP开关状态(GetVmRDP)

设置云主机RDP开关状态(SetVmRDP)

获取云主机支持的屏幕数(GetVmMonitorNumber)

设置云主机支持的屏幕数(SetVmMonitorNumber)

修改云主机根云盘(ChangeVmImage)

获取候选镜像列表(GetImageCandidatesForVmToChange)

更新云主机mac地址(UpdateVmNicMac)

设置云主机防IP欺骗启用状态(SetVmCleanTraffic)

为云主机创建CDROM(CreateVmCdRom)

删除CDROM(DeleteVmCdRom)

修改CDROM(UpdateVmCdRom)

设置云主机默认CDROM(SetVmInstanceDefaultCdRom)

查询CDROM清单(QueryVmCdRom)

更改云主机优先级级别(UpdateVmPriority)

设置云主机显存(SetVmQxlMemory)

设置云主机虚拟声卡类型(SetVmSoundType)

获取spice的CA证书(GetSpiceCertificates)

为云主机加载增强工具镜像(AttachGuestToolsIsoToVm)

获取云主机可用的最新增强工具(GetLatestGuestToolsForVm)

获取云主机内部增强工具的信息(GetVmGuestToolsInfo)

获取云主机第一启动项(GetVmInstanceFirstBootDevice)

设置网卡型号(UpdateVmNicDriver)

获取云主机设备地址(GetVmDeviceAddress)

批量获取云主机能力(GetVmsCapabilities)

设置云主机vNUMA（SetVmNuma）

获取VM Numa开关状态（GetVmNuma）

查询云主机的vNUMA拓扑信息（GetVmvNUMATopology）

设置云主机Emulator Pinning功能（SetVmEmulatorPinning）

获取VM Emulator Pin在那些物理机的cpu上（GetVmEmulatorPinning）

查询虚拟机调度历史（QueryVmSchedHistory）

扁平合并云主机(FlattenVmInstance)

云主机执行命令(ExecuteGuestVmCommand)

发送文件到云主机(UploadFileToVm)

修改云主机主板类型(SetVmMachineType)

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

裸金属管理(Plus)

弹性裸金属管理(Plus)

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管理使用教程

计费功能使用教程

账户管理使用教程

日志服务器配置教程

自定义主题外观配置教程

应用市场开发使用教程

云平台管理规范指南

操作系统修复指南

云主机相关接口

118 个主题

创建云主机CreateVmInstance按照指定规格和镜像创建新的云主机实例。
从云盘创建云主机CreateVmInstanceFromVolume基于已有云盘新建云主机。
从快照创建云主机CreateVmInstanceFromVolumeSnapshot使用已有云盘快照新建云主机。
从快照组创建云主机CreateVmInstanceFromVolumeSnapshotGroup使用已有云盘快照组新建云主机。
从OVF模板导入云主机CreateVmInstanceFromOvf导入OVF模板中的配置并创建云主机。
导出云主机的OVA包ExportVmOvaPackage将云主机导出为可交付的OVA包。
解析OVF模板信息ParseOvf读取OVF模板中定义的虚拟机配置信息。
删除云主机DestroyVmInstance删除指定云主机，结束该实例的使用。
恢复已删除云主机RecoverVmInstance将已删除的云主机恢复为停止状态。
彻底删除云主机ExpungeVmInstance永久清除已删除云主机及其根云盘数据。
查询云主机QueryVmInstance按条件检索云主机，返回匹配记录。
启动云主机StartVmInstance使停止的云主机开始运行。
停止云主机StopVmInstance结束指定云主机当前的运行状态。
重启云主机RebootVmInstance使指定云主机重新启动并运行。
暂停云主机PauseVmInstance暂停云主机运行，并将当前状态保留在内存中。
恢复暂停的云主机ResumeVmInstance从内存中恢复此前暂停的云主机运行状态。
重置云主机ReimageVmInstance将云主机根云盘恢复到初始镜像状态。
创建资源分组目录CreateDirectory新建用于组织云主机的资源分组目录。
删除资源分组目录DeleteDirectory删除指定的资源分组目录。
添加资源至分组目录AddResourcesToDirectory将云主机加入分组目录，便于分类管理。
移动资源至分组目录MoveResourcesToDirectory调整资源所属的分组目录，重新组织资源。
从分组目录移除资源RemoveResourcesFromDirectory解除资源与分组目录之间的归属关系。
更新分组目录UpdateDirectory调整资源分组目录的配置信息。
查询分组目录QueryDirectory按条件检索资源分组目录及其属性。
热迁移云主机MigrateVm将运行中的云主机热迁移到另一台物理机。
查询共享磁盘所挂载的云主机QueryShareableVolumeVmInstanceRef按条件检索共享磁盘所挂载的云主机，返回匹配记录。
获取可热迁移的物理机列表GetVmMigrationCandidateHosts筛选能够接收云主机热迁移的物理机。
获取创建云主机时可选择的主存储GetCandidatePrimaryStoragesForCreatingVm筛选创建指定云主机时可使用的主存储。
获取云主机可加载ISO列表GetCandidateIsoForAttachingVm列出能够挂载到指定云主机的ISO镜像。
获取ISO可加载云主机列表GetCandidateVmForAttachingIso查找能够挂载指定ISO镜像的云主机。
加载ISO到云主机AttachIsoToVmInstance为指定云主机挂载需要使用的ISO镜像。
卸载云主机上的ISODetachIsoFromVmInstance移除云主机当前挂载的ISO镜像。
获取云主机可加载云盘列表GetVmAttachableDataVolume筛选能够挂载到指定云主机的数据云盘。
获取云主机可加载L3网络列表GetVmAttachableL3Network筛选能够接入指定云主机的三层网络。
获取资源虚拟化软件信息GetVirtualizerInfo查看资源关联的虚拟化软件信息。
加载L3网络到云主机AttachL3NetworkToVm为云主机新增三层网络连接。
从云主机卸载网络DetachL3NetworkFromVm解除云主机与指定三层网络的连接。
创建云主机网卡CreateVmNic创建可以挂载到云主机上的虚拟网卡。
修改云主机网卡状态ChangeVmNicState控制指定云主机网卡的工作状态。
加载网卡到云主机AttachVmNicToVm将已有网卡关联到指定云主机。
删除云主机网卡DeleteVmNic移除云主机中指定的虚拟网卡。
更改网卡的默认流量策略ChangeVmNicSecurityPolicy调整云主机网卡默认允许或拒绝的流量策略。
查询云主机网卡QueryVmNic按条件检索云主机网卡，返回匹配记录。
获取网卡加载的网络服务名称GetVmNicAttachedNetworkService列出指定网卡已经关联的网络服务。
修改云主机网卡三层网络ChangeVmNicNetwork将已停止云主机的网卡切换到其他三层网络。
获取云主机网卡可挂载的三层网络GetCandidateL3NetworksForChangeVmNicNetwork列出云主机网卡切换网络时可用的三层网络。
设置云主机网卡限速SetNicQos限制云主机网卡使用的网络带宽。
获取云主机网卡限速GetNicQos读取云主机网卡当前的带宽限制。
取消云主机网卡限速DeleteNicQos解除云主机网卡已配置的带宽限制。
获取相互依赖的镜像和L3网络GetInterdependentL3NetworksImages核对三层网络与镜像是否满足相互依赖条件。
设置云主机SSH KeySetVmSshKey为云主机登录配置SSH密钥。
获取云主机SSH KeyGetVmSshKey读取云主机当前配置的SSH登录密钥。
删除云主机SSH KeyDeleteVmSshKey清除云主机当前配置的SSH登录密钥。
变更云主机密码ChangeVmPassword更新云主机操作系统使用的登录密码。
设置云主机控制台密码SetVmConsolePassword为访问云主机控制台设置密码。
删除云主机控制台密码DeleteVmConsolePassword清除云主机控制台当前配置的访问密码。
获取云主机控制台密码GetVmConsolePassword读取访问云主机控制台所使用的密码。
更新云主机控制台密码UpdateConsolePassword调整云主机控制台密码的配置信息。
获取云主机控制台地址和访问协议GetVmConsoleAddress取得访问云主机控制台所需的地址与协议。
设置云主机HostnameSetVmHostname为云主机指定操作系统主机名。
获取云主机HostnameGetVmHostname读取云主机当前设置的主机名。
删除云主机HostnameDeleteVmHostname清除云主机已配置的Hostname信息。
创建启动云主机的定时任务CreateStartVmInstanceScheduler按指定配置新建启动云主机的定时任务。
创建停止云主机的定时任务CreateStopVmInstanceScheduler按指定配置新建停止云主机的定时任务。
创建重启云主机的定时任务CreateRebootVmInstanceScheduler按指定配置新建重启云主机的定时任务。
获取云主机启动设备列表GetVmBootOrder读取云主机当前配置的启动设备顺序。
指定云主机启动设备SetVmBootOrder调整云主机尝试启动各设备的先后顺序。
查找创建云主机的可用位置GetCandidateZonesClustersHostsForCreatingVm根据创建需求查找可用区域、集群和物理机。
获取云主机可启动目的地列表GetVmStartingCandidateClustersHosts查找停止的云主机可以启动的集群和物理机。
指定云主机IPSetVmStaticIp为云主机网卡指定三层网络中的IP地址。
删除云主机指定IPDeleteVmStaticIp移除云主机在指定三层网络中的固定IP配置。
获取云主机能力GetVmCapabilities检查云主机当前可以执行的操作。
更新云主机信息UpdateVmInstance调整云主机的配置信息。
克隆云主机CloneVmInstance在指定物理机上创建现有云主机的副本。
设置云主机时钟同步SetVmClockTrack配置云主机的时钟跟踪与同步方式。
立即同步云主机时钟SyncVmClock立即执行云主机时钟同步。
设置云主机高可用级别SetVmInstanceHaLevel为云主机指定所使用的高可用级别。
获取云主机高可用级别GetVmInstanceHaLevel读取云主机当前采用的高可用级别。
取消云主机高可用DeleteVmInstanceHaLevel移除云主机当前设置的高可用级别。
获取云主机QgaGetVmQga读取云主机QEMU Guest Agent的配置状态。
设置云主机QgaSetVmQga设置云主机QEMU Guest Agent的配置。
获取云主机GuestTools状态QueryGuestToolsState读取云主机内部增强工具当前的运行状态。
更新云主机GuestTools状态UpdateGuestToolsState更新云主机内部增强工具的状态信息。
同步云主机网络配置UpdateVmNetworkConfig同步云主机网卡的网络配置信息。
获取云主机RDP开关状态GetVmRDP查询云主机远程桌面协议是否启用。
设置云主机RDP开关状态SetVmRDP控制云主机是否开启RDP远程桌面协议。
获取云主机支持的屏幕数GetVmMonitorNumber读取云主机可以使用的显示屏数量。
设置云主机支持的屏幕数SetVmMonitorNumber调整云主机可以使用的显示屏数量。
修改云主机根云盘ChangeVmImage使用其他镜像替换云主机当前的根云盘。
获取候选镜像列表GetImageCandidatesForVmToChange筛选可用于替换云主机根云盘的镜像。
更新云主机mac地址UpdateVmNicMac调整云主机mac地址的配置信息。
设置云主机防IP欺骗启用状态SetVmCleanTraffic配置云主机的IP地址防欺骗功能。
为云主机创建CDROMCreateVmCdRom为云主机增加可挂载ISO的CDROM设备。
删除CDROMDeleteVmCdRom移除云主机中指定的CDROM设备。
修改CDROMUpdateVmCdRom调整CDROM的配置信息。
设置云主机默认CDROMSetVmInstanceDefaultCdRom为云主机选择默认使用的CDROM设备。
查询CDROM清单QueryVmCdRom按条件检索CDROM清单，返回匹配记录。
更改云主机优先级级别UpdateVmPriority调整云主机优先级级别的配置信息。
设置云主机显存SetVmQxlMemory调整云主机图形显示所使用的显存。
设置云主机虚拟声卡类型SetVmSoundType选择云主机使用的虚拟声卡型号。
获取spice的CA证书GetSpiceCertificates读取建立SPICE连接时使用的CA证书。
为云主机加载增强工具镜像AttachGuestToolsIsoToVm将增强工具ISO镜像挂载到云主机。
获取云主机可用的最新增强工具GetLatestGuestToolsForVm查找适用于指定云主机的最新增强工具。
获取云主机内部增强工具的信息GetVmGuestToolsInfo查看云主机内部已安装增强工具的信息。
获取云主机第一启动项GetVmInstanceFirstBootDevice确定云主机首先尝试启动的设备。
设置网卡型号UpdateVmNicDriver选择云主机网卡所使用的虚拟型号。
获取云主机设备地址GetVmDeviceAddress关联云主机内部设备地址与平台资源。
批量获取云主机能力GetVmsCapabilities批量检查多台云主机当前可执行的操作。
设置云主机vNUMASetVmNuma为云主机配置虚拟NUMA。
获取VM Numa开关状态GetVmNuma查询云主机NUMA功能是否启用。
查询云主机的vNUMA拓扑信息GetVmvNUMATopology查看云主机的虚拟NUMA节点拓扑。
设置云主机Emulator Pinning功能SetVmEmulatorPinning将云主机模拟器线程绑定到指定物理CPU。
获取VM Emulator Pin在那些物理机的cpu上GetVmEmulatorPinning查询云主机模拟器线程绑定的物理CPU。
查询虚拟机调度历史QueryVmSchedHistory按条件检索虚拟机调度历史，返回匹配记录。
扁平合并云主机FlattenVmInstance合并云主机的快照链，完成扁平化处理。
云主机执行命令ExecuteGuestVmCommand将指定命令发送到云主机内部执行。
发送文件到云主机UploadFileToVm将指定文件传输到云主机内部。
修改云主机主板类型SetVmMachineType选择云主机所使用的虚拟主板类型。

上一篇使用AK调用API 下一篇创建云主机(CreateVmInstance)

本页目录

云主机相关接口

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

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

文档中心知识库安全 API Explorer

ZH/EN