PrimaryStorageMigrateVm

PUT/zstack/v1/vm-instances/{vmInstanceUuid}/actions

Operation ID

PrimaryStorageMigrateVm

Since

3.1.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

vmInstanceUuid
StringRequired
The VM instance UUID.

Body Fields

dstPrimaryStorageUuid
StringRequired
The UUID of the destination primary storage.
withDataVolumes
boolean
Optional. Migrates the VM instance with its data volumes.
withSnapshots
boolean
Optional. Migrates the VM instance with its snapshots.
dstHostUuid
String
Optional.
strategy
String
The strategy.

Responses

200 OK

On success, this API returns the following response structure.

success
booleanRequired
Whether the operation succeeded.
error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The detailed description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
VmInstanceInventoryRequired
See inventory.
uuid
StringRequired
The resource UUID.
name
StringRequired
The resource name.
description
StringRequired
The detailed description of the resource.
zoneUuid
StringRequired
The zone UUID.
clusterUuid
StringRequired
The cluster UUID.
imageUuid
StringRequired
The image UUID.
hostUuid
StringRequired
The host UUID.
lastHostUuid
StringRequired
The last host UUID.
instanceOfferingUuid
StringRequired
The instance offering UUID.
rootVolumeUuid
StringRequired
The root volume UUID.
platform
StringRequired
The platform.
architecture
StringRequired
The architecture.
defaultL3NetworkUuid
StringRequired
The default L3 network UUID.
type
StringRequired
The resource type.
hypervisorType
StringRequired
The hypervisor type.
memorySize
LongRequired
The memory size.
cpuNum
IntegerRequired
The number of CPUs.
cpuSpeed
LongRequired
The CPU speed.
allocatorStrategy
StringRequired
The allocator strategy.
createDate
TimestampRequired
The creation date.
lastOpDate
TimestampRequired
The last operation date.
state
StringRequired
The resource state.
guestOsType
StringRequired
The guest OS type.
vmNics
ListRequired
See vmNics.
allVolumes
ListRequired
See allVolumes.
vmCdRoms
ListRequired
See vmCdRoms.
uuid
StringRequired
The resource UUID.
vmInstanceUuid
StringRequired
The VM instance UUID.
l3NetworkUuid
StringRequired
The L3 network UUID.
ip
StringRequired
The IP address.
mac
StringRequired
The MAC address.
netmask
StringRequired
The netmask.
gateway
StringRequired
The gateway IP address.
metaData
StringRequired
The metadata.
deviceId
IntegerRequired
The device ID.
createDate
TimestampRequired
The creation date.
lastOpDate
TimestampRequired
The last operation date.
usedIps
ListRequired
See usedIps.
uuid
StringRequired
The resource UUID.
ipRangeUuid
StringRequired
The IP range UUID.
l3NetworkUuid
StringRequired
The L3 network UUID.
ipVersion
IntegerRequired
The IP version.
ip
StringRequired
The IP address.
netmask
StringRequired
The netmask.
gateway
StringRequired
The gateway.
usedFor
StringRequired
The intended use.
ipInLong
longRequired
The IP address represented as a long integer.
vmNicUuid
StringRequired
The VM NIC UUID.
createDate
TimestampRequired
The creation date.
lastOpDate
TimestampRequired
The last operation date.
uuid
StringRequired
The resource UUID.
name
StringRequired
The resource name.
description
StringRequired
The detailed description of the resource.
primaryStorageUuid
StringRequired
The primary storage UUID.
vmInstanceUuid
StringRequired
The VM instance UUID.
diskOfferingUuid
StringRequired
The disk offering UUID.
rootImageUuid
StringRequired
The root image UUID.
installPath
StringRequired
The installation path.
type
StringRequired
The resource type.
format
StringRequired
The format.
size
LongRequired
The size.
actualSize
LongRequired
The actual size.
deviceId
IntegerRequired
The device ID.
state
StringRequired
The resource state.
status
StringRequired
The resource status.
createDate
TimestampRequired
The creation date.
lastOpDate
TimestampRequired
The last operation date.
isShareable
BooleanRequired
Whether the resource is shareable.
uuid
StringRequired
The resource UUID.
vmInstanceUuid
StringRequired
The VM instance UUID.
deviceId
IntegerRequired
The device ID.
isoUuid
StringRequired
The ISO UUID.
isoInstallPath
StringRequired
The ISO install path.
name
StringRequired
The resource name.
description
String
Optional. The detailed description of the resource.
createDate
TimestampRequired
The creation date.
lastOpDate
TimestampRequired
The last operation date.

Request Example

curl -X PUT '{host}/zstack/v1/vm-instances/{vmInstanceUuid}/actions' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "dstPrimaryStorageUuid": "{dstPrimaryStorageUuid}",
  "withDataVolumes": "{withDataVolumes}",
  "withSnapshots": "{withSnapshots}",
  "dstHostUuid": "{dstHostUuid}",
  "strategy": "{strategy}",
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ],
  "migrateVm": {
    "downTime": "{downTime}",
    "bandwidth": "{bandwidth}"
  }
}'

Response Example

{
  "inventory": {
    "uuid": "f483af349d39312c8078d142c40fb721",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "b7280443258337bb9e8d2abf4a014644",
    "clusterUuid": "a2c0ace5be2d35b5a365067a0127b377",
    "imageUuid": "14fb13b692e837dfa31d75ffc02d4d4d",
    "hostUuid": "f0690203b1463867bcb2f5a48a1fa91a",
    "lastHostUuid": "655acef664af39e9b6b7fec0d4de56c0",
    "instanceOfferingUuid": "772a66f21ef23ba7a69ad292e4489ebb",
    "rootVolumeUuid": "65b10a950f1336f48b770f98b25176eb",
    "platform": "Linux",
    "defaultL3NetworkUuid": "80c8af5ff0a135e18a3e7a4d2223ebd2",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 9:20:57 AM",
    "lastOpDate": "Nov 14, 2017 9:20:57 AM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "b16455db309330289acb58edbfabd4b7",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "usedIpUuid": "27787a727c143a7aada42e6c3b111887",
        "l3NetworkUuid": "80c8af5ff0a135e18a3e7a4d2223ebd2",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "65b10a950f1336f48b770f98b25176eb",
        "name": "Root-Volume-For-VM-f483af349d39312c8078d142c40fb721",
        "primaryStorageUuid": "55245463f914331c954909475279c3b0",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "diskOfferingUuid": "b2cb37282f5034fb808dff68dc18db9e",
        "rootImageUuid": "14fb13b692e837dfa31d75ffc02d4d4d",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-65b10a950f1336f48b770f98b25176eb/65b10a950f1336f48b770f98b25176eb.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      },
      {
        "uuid": "97bf368f3bde3490b0c08d37ac8bc747",
        "name": "Data-Volume-For-VM-f483af349d39312c8078d142c40fb721",
        "primaryStorageUuid": "4df2eddd6ac1307ebbff27d0044f72e9",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "diskOfferingUuid": "06ea8f5a59843b8aa4d18d9c6d2b7a1d",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-97bf368f3bde3490b0c08d37ac8bc747/97bf368f3bde3490b0c08d37ac8bc747.qcow2",
        "type": "Data",
        "format": "qcow2",
        "size": 536870912000,
        "actualSize": 107374182400,
        "deviceId": 1,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ]
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-08-12
AddedResponse fields actualSize, allVolumes, allocatorStrategy...
View API

VM Instance Operations

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

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations