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

Tutorials

Quick Installation and Usage Tutorial

Upgrade Tutorial

Product Manuals

Security Whitepaper

CLI Command Manual

CTL Command Manual

Development Manuals

RESTful API Overview

API Call with AccessKey

VM Instance Operations

CreateVmInstance

CreateVmInstanceFromVolume

CreateVmInstanceFromVolumeSnapshot

CreateVmInstanceFromVolumeSnapshotGroup

CreateVmInstanceFromOvf

ExportVmOvaPackage

DestroyVmInstance

RecoverVmInstance

ExpungeVmInstance

QueryVmInstance

StartVmInstance

RebootVmInstance

PauseVmInstance

ResumeVmInstance

ReimageVmInstance

CreateDirectory

DeleteDirectory

AddResourcesToDirectory

MoveResourcesToDirectory

RemoveResourcesFromDirectory

UpdateDirectory

QueryShareableVolumeVmInstanceRef

GetVmMigrationCandidateHosts

GetCandidatePrimaryStoragesForCreatingVm

GetCandidateIsoForAttachingVm

GetCandidateVmForAttachingIso

AttachIsoToVmInstance

DetachIsoFromVmInstance

GetVmAttachableDataVolume

GetVmAttachableL3Network

GetVirtualizerInfo

AttachL3NetworkToVm

DetachL3NetworkFromVm

ChangeVmNicState

AttachVmNicToVm

GetVmNicAttachedNetworkService

ChangeVmNicNetwork

GetCandidateL3NetworksForChangeVmNicNetwork

GetInterdependentL3NetworksImages

ChangeVmPassword

SetVmConsolePassword

GetVmConsolePassword

DeleteVmConsolePassword

GetVmConsoleAddress

DeleteVmHostname

CreateStartVmInstanceScheduler

CreateStopVmInstanceScheduler

CreateRebootVmInstanceScheduler

GetCandidateZonesClustersHostsForCreatingVm

GetVmStartingCandidateClustersHosts

DeleteVmStaticIp

GetVmCapabilities

UpdateVmInstance

CloneVmInstance

SetVmClockTrack

SetVmInstanceHaLevel

GetVmInstanceHaLevel

DeleteVmInstanceHaLevel

QueryGuestToolsState

UpdateGuestToolsState

UpdateVmNetworkConfig

GetVmMonitorNumber

SetVmMonitorNumber

GetImageCandidatesForVmToChange

SetVmCleanTraffic

SetVmInstanceDefaultCdRom

UpdateVmPriority

GetSpiceCertificates

AttachGuestToolsIsoToVm

GetLatestGuestToolsForVm

GetVmGuestToolsInfo

GetVmInstanceFirstBootDevice

UpdateVmNicDriver

GetVmDeviceAddress

GetVmsCapabilities

GetVmvNUMATopology

SetVmEmulatorPinning

GetVmEmulatorPinning

QueryVmSchedHistory

FlattenVmInstance

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

CloudFormation Operations

Bare Metal Management (Plus)

Elastic Bare Metal Management(Plus)

Tutorials

License Update Guide

Dual-MN HA Tutorial

Host Network Configuration Tutorial

Tenant Management Tutorial

Backup Service Tutorial

Continuous Data Protection (CDP) Tutorial

VMware Management Tutorial

Alibaba Cloud Hybrid Cloud Tutorial

V2V Migration Tutorial

VPC Network Tutorial

Flat Network Tutorial

USB Passthrough Tutorial

Smart NIC Tutorial

CentOS 8 Template Tutorial

Windows Server 2008 R2 ~ 2019 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

Account Management Tutorial

Theme & Appearance Customization Tutorial

VM Instance Operations

112 topics

Create a VM instanceCreateVmInstanceCreate a new VM instance using the specified configuration.
Create a VM from a volumeCreateVmInstanceFromVolumeCreate a VM instance from an existing volume.
Create a VM from a snapshotCreateVmInstanceFromVolumeSnapshotCreate a VM instance from a volume snapshot.
Create a VM from a snapshot groupCreateVmInstanceFromVolumeSnapshotGroupCreate a VM instance from a volume snapshot group.
Import a VM from OVFCreateVmInstanceFromOvfImport a VM instance from an OVF template.
Export a VM as OVAExportVmOvaPackageExport a VM instance as an OVA package.
Read an OVF template's VM configurationParseOvfRead the VM configuration described by an OVF template.
Delete a VM instanceDestroyVmInstanceDelete a VM instance from the cloud platform.
Recover a deleted VMRecoverVmInstanceRestore a deleted VM instance to the stopped state.
Permanently delete a VMExpungeVmInstancePermanently remove a deleted VM instance and its root volume.
Query VM instancesQueryVmInstanceFind VM instances matching the specified query conditions.
Start an existing VM instanceStartVmInstanceStart an existing VM instance through the cloud platform.
Stop a running VM instanceStopVmInstanceStop a running VM instance through the cloud platform.
Restart a VM instanceRebootVmInstanceRestart a VM instance through the cloud platform.
Pause a VM instancePauseVmInstancePause a VM instance while retaining its state in memory.
Resume a paused VMResumeVmInstanceResume a paused VM instance from its retained memory state.
Reset a VM's root volumeReimageVmInstanceReset a VM's root volume to its original image state.
Create a resource grouping directoryCreateDirectoryCreate a grouping directory to organize VM instances.
Delete resource grouping directoryDeleteDirectoryDelete the specified resource grouping directory from the platform.
Add VMs to a resource directoryAddResourcesToDirectoryAdd VM instances to a resource grouping directory.
Move VMs to another resource directoryMoveResourcesToDirectoryMove VM instances into a different resource grouping directory.
Remove VMs from a resource directoryRemoveResourcesFromDirectoryRemove VM instances from a resource grouping directory.
Update resource grouping directoryUpdateDirectoryUpdate the configuration of the specified resource grouping directory.
Live migrate a VMMigrateVmLive migrate a VM instance to another physical host.
Find VMs using a shared volumeQueryShareableVolumeVmInstanceRefFind VM instances attached to a shared volume.
Find hosts for VM live migrationGetVmMigrationCandidateHostsList physical hosts available for VM live migration.
Find storage for a new VMGetCandidatePrimaryStoragesForCreatingVmList primary storage candidates for creating a VM instance.
Find ISO images for a VMGetCandidateIsoForAttachingVmList ISO images attachable to a specified VM instance.
Find VMs that can mount an ISOGetCandidateVmForAttachingIsoList VM instances that can mount a specified ISO image.
Mount a VM ISO imageAttachIsoToVmInstanceMount an ISO image on a VM instance.
Unmount a VM ISO imageDetachIsoFromVmInstanceUnmount an ISO image from a VM instance.
Find volumes attachable to a VMGetVmAttachableDataVolumeList data volumes attachable to a specified VM instance.
Find networks attachable to a VMGetVmAttachableL3NetworkList L3 networks attachable to a specified VM instance.
View resource virtualization softwareGetVirtualizerInfoInspect virtualization software information associated with a resource.
Attach an L3 network to a VMAttachL3NetworkToVmAttach an L3 network to a VM instance.
Detach an L3 network from a VMDetachL3NetworkFromVmDetach an L3 network from a VM instance.
Create a VM network interfaceCreateVmNicCreate a new VM network interface using the specified configuration.
Change a VM NIC's stateChangeVmNicStateChange the operating state of a VM NIC.
Attach an existing VM NICAttachVmNicToVmAttach an existing NIC to a VM instance.
Delete VM network interfaceDeleteVmNicDelete the specified VM network interface from the platform.
Query VM network interfacesQueryVmNicFind VM network interfaces matching the specified query conditions.
List a VM NIC's network servicesGetVmNicAttachedNetworkServiceList network services attached to a VM NIC.
Change a VM NIC's L3 networkChangeVmNicNetworkMove a stopped VM's NIC to another L3 network.
Find networks for a VM NICGetCandidateL3NetworksForChangeVmNicNetworkList L3 networks available for changing a VM NIC's network.
Set VM NIC bandwidth limitsSetNicQosLimit the bandwidth used by a VM NIC.
View VM NIC bandwidth limitsGetNicQosRead bandwidth limits configured for a VM NIC.
Remove VM NIC bandwidth limitsDeleteNicQosRemove the bandwidth limit configured for a VM NIC.
Inspect network and image dependenciesGetInterdependentL3NetworksImagesCheck dependencies between L3 networks and VM images.
Set a VM's SSH keySetVmSshKeyConfigure an SSH key for VM instance access.
View a VM's SSH keyGetVmSshKeyRead the SSH key configured for a VM instance.
Remove a VM's SSH keyDeleteVmSshKeyRemove the SSH key configured for a VM instance.
Change a VM's login passwordChangeVmPasswordChange the login password of a VM instance.
Set the VM console passwordSetVmConsolePasswordSet the password used to access a VM console.
View the VM console passwordGetVmConsolePasswordRead the password configured for a VM console.
Remove the VM console passwordDeleteVmConsolePasswordRemove the password configured for a VM console.
View VM console connection detailsGetVmConsoleAddressObtain the console address and protocol of a VM instance.
Set a VM hostnameSetVmHostnameAssign a hostname to a VM instance.
View a VM hostnameGetVmHostnameRead the hostname configured for a VM instance.
Remove a VM hostnameDeleteVmHostnameRemove the hostname configured for a VM instance.
Schedule a VM startCreateStartVmInstanceSchedulerSchedule a task to start a VM instance.
Schedule a VM stopCreateStopVmInstanceSchedulerSchedule a task to stop a VM instance.
Schedule a VM rebootCreateRebootVmInstanceSchedulerSchedule a task to reboot a VM instance.
View VM boot device orderGetVmBootOrderRead the boot device order of a VM instance.
Set the VM boot orderSetVmBootOrderChoose the boot device order for a VM instance.
Find available placement for a VMGetCandidateZonesClustersHostsForCreatingVmFind zones, clusters, and hosts matching VM creation requirements.
Find where a VM can startGetVmStartingCandidateClustersHostsFind clusters and hosts where a stopped VM can start.
Set a VM NIC's IP addressSetVmStaticIpAssign a specified IP address to a VM NIC.
Remove the IP configuration from a VM's L3 networkDeleteVmStaticIpRemove the specified IP configuration from a VM's L3 network.
View supported VM operationsGetVmCapabilitiesDetermine which operations a VM instance can perform.
Update VM instanceUpdateVmInstanceUpdate the configuration of the specified VM instance.
Clone a VM to a hostCloneVmInstanceClone a VM instance to a specified host.
Set VM clock trackingSetVmClockTrackConfigure how a VM instance tracks its clock.
Sync the VM clockSyncVmClockSynchronize the clock of a VM instance immediately.
Set the VM HA levelSetVmInstanceHaLevelConfigure the HA level of a VM instance.
View VM high availability levelGetVmInstanceHaLevelRead the HA level configured for a VM instance.
Remove the VM HA settingDeleteVmInstanceHaLevelRemove the HA setting configured for a VM instance.
View VM QEMU guest agent settingsGetVmQgaRead the QEMU guest agent setting of a VM instance.
Configure the VM's QEMU guest agentSetVmQgaConfigure the QEMU guest agent setting for a VM instance.
View VM guest tools stateQueryGuestToolsStateInspect the guest tools state of a VM instance.
Update VM guest tools stateUpdateGuestToolsStateUpdate the guest tools state of a VM instance.
Sync a VM's network configurationUpdateVmNetworkConfigSynchronize the network configuration of a VM instance.
Check VM RDP statusGetVmRDPRead whether RDP is enabled for a VM instance.
Enable or disable VM RDPSetVmRDPEnable or disable RDP for a VM instance.
View VM monitor countGetVmMonitorNumberRead the number of monitors supported by a VM instance.
Set VM monitor countSetVmMonitorNumberConfigure the number of monitors for a VM instance.
Replace a VM's root volumeChangeVmImageReplace a VM instance's root volume using another image.
Find replacement images for a VMGetImageCandidatesForVmToChangeList image candidates for replacing a VM's root volume.
Change a VM NIC's MAC addressUpdateVmNicMacChange the MAC address configured for a VM NIC.
Configure VM IP spoofing protectionSetVmCleanTrafficConfigure IP spoofing protection for a VM instance.
Create a VM CDROM deviceCreateVmCdRomCreate a new VM CDROM device using the specified configuration.
Delete VM CDROM deviceDeleteVmCdRomDelete the specified VM CDROM device from the platform.
Update VM CDROM deviceUpdateVmCdRomUpdate the configuration of the specified VM CDROM device.
Set the default VM CDROMSetVmInstanceDefaultCdRomChoose the default CDROM device of a VM instance.
Query VM CDROM devicesQueryVmCdRomFind VM CDROM devices matching the specified query conditions.
Change a VM's priority levelUpdateVmPriorityChange the priority level of a VM instance.
Set VM QXL graphics memorySetVmQxlMemoryConfigure graphics memory for a VM instance.
Choose the VM sound card typeSetVmSoundTypeChoose the virtual sound card type of a VM instance.
Get SPICE CA certificatesGetSpiceCertificatesRetrieve CA certificates used for SPICE connections.
Mount the VM guest tools ISOAttachGuestToolsIsoToVmMount the guest tools ISO on a VM instance.
Find the latest VM guest toolsGetLatestGuestToolsForVmFind the latest guest tools available for a VM instance.
Inspect VM guest toolsGetVmGuestToolsInfoInspect guest tools installed inside a VM instance.
View a VM's first boot deviceGetVmInstanceFirstBootDeviceRead the first boot device of a VM instance.
Choose a VM NIC modelUpdateVmNicDriverChoose the network adapter model for a VM NIC.
Map VM device addressesGetVmDeviceAddressMap VM device addresses to resources on the platform.
View supported operations for multiple VMsGetVmsCapabilitiesRetrieve supported operations for multiple VM instances at once.
Configure virtual NUMA for a VMSetVmNumaConfigure virtual NUMA for a VM instance.
Check VM NUMA statusGetVmNumaRead whether NUMA is enabled for a VM instance.
View a VM's vNUMA topologyGetVmvNUMATopologyInspect the virtual NUMA topology of a VM instance.
Configure VM emulator CPU pinningSetVmEmulatorPinningPin a VM's emulator threads to selected physical CPUs.
View VM emulator CPU pinningGetVmEmulatorPinningInspect the physical CPUs assigned to a VM's emulator.
View VM scheduling historyQueryVmSchedHistoryReview the scheduling history of VM instances.
Flatten a VM snapshot chainFlattenVmInstanceFlatten a VM instance's snapshot chain by merging snapshots.

PreviousAPI Call with AccessKey NextCreateVmInstance

On this page

VM Instance Operations

Copyright © 2026 ZStack. All rights reserved.

Site Terms Privacy Policy User Management Rules

Docs Knowledge Base Security API Explorer

ZH/EN