CreateVmFromVmBackup

POST/zstack/v1/vm-instances/from/vm-backups/{groupUuid}

Operation ID

CreateVmFromVmBackup

Since

3.0.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

groupUuid
StringRequired
The UUID of the VM backup group.

Body Fields

params
ObjectRequired
Request body parameter object.
- name
  StringRequired
  The name of the VM.
- backupStorageUuid
  String
  Optional. The UUID of the backup storage.
- instanceOfferingUuid
  StringRequired
  The UUID of the instance offering.
- l3NetworkUuids
  List
  Optional. The UUIDs of L3 networks.
- vmNicParams
  String
  Optional.The information of the vmNic
- type
  String
  Optional. The type of the VM instance.
- zoneUuid
  String
  Optional. The zone UUID.
- clusterUuid
  String
  Optional. The cluster UUID.
- hostUuid
  String
  Optional. The host UUID.
- primaryStorageUuidForRootVolume
  String
  Optional. The primary storage used to host the root volume.
- primaryStorageUuidForDataVolume
  String
  Optional. The primary storage used to host data volumes.
- description
  String
  Optional. The detailed description of the VM.
- rootVolumeSystemTags
  List
  Optional. The system tags of the root volume.
- dataVolumeSystemTags
  List
  Optional. The system tags of the data volume.
- defaultL3NetworkUuid
  String
  The UUID of the L3 network.
- resourceUuid
  String
  Optional.
- tagUuids
  List
  Optional. The tagUuids.
- strategy
  String
  Optional. The srategy to create vms.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

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 brief 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 UUID of the VM instance.
- name
  StringRequired
  The name of the VM instance.
- description
  StringRequired
  The detailed description of the VM instance.
- 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 UUID of the instance offering.
- rootVolumeUuid
  StringRequired
  The UUID of the root volume.
- 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 time when the VM instance was created.
- lastOpDate
  TimestampRequired
  The time when the VM instance was last modified.
- state
  StringRequired
  The resource state.
- guestOsType
  StringRequired
  The guest OS type.
- vmNics
  ListRequired
  See vmNics
  uuid
  StringRequired
  The UUID of the NIC of the VM instance.
  vmInstanceUuid
  StringRequired
  The UUID of the VM instance.
  l3NetworkUuid
  StringRequired
  The UUID of the L3 network.
  ip
  StringRequired
  The IP address.
  mac
  StringRequired
  The MAC address.
  hypervisorType
  StringRequired
  The hypervisor type.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  metaData
  StringRequired
  The metadata.
  ipVersion
  IntegerRequired
  The IP version.
  driverType
  StringRequired
  The driver type.
  internalName
  StringRequired
  The internal name.
  deviceId
  IntegerRequired
  The device ID.
  type
  StringRequired
  The resource type.
  state
  StringRequired
  The state of the vmNics.
  createDate
  TimestampRequired
  The time when the NIC was created.
  lastOpDate
  TimestampRequired
  The time when the NIC was last modified.
  usedIps
  ListRequired
  See usedIps
  uuid
  StringRequired
  The UUID of the volume.
  ipRangeUuid
  StringRequired
  The UUID of the ip range.
  l3NetworkUuid
  StringRequired
  The UUID of the L3network.
  ipVersion
  IntegerRequired
  The IP version.
  ip
  StringRequired
  The IP address.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  usedFor
  StringRequired
  The intended use.
  ipInLong
  longRequired
  The IP address represented as a long integer.
  vmNicUuid
  StringRequired
  The UUID of the vmNic.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.
- allVolumes
  ListRequired
  See allVolumes
  uuid
  StringRequired
  The UUID of the volume.
  name
  StringRequired
  The name of the volume.
  description
  StringRequired
  The detailed description of the volume.
  primaryStorageUuid
  StringRequired
  The UUID of the primary storage.
  vmInstanceUuid
  StringRequired
  The UUID of the VM instance.
  diskOfferingUuid
  StringRequired
  The UUID of the disk offering.
  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 time when the volume was created.
  lastOpDate
  TimestampRequired
  The time when the volume was last modified.
  isShareable
  BooleanRequired
  Whether the resource is shareable.
  volumeQos
  StringRequired
  The volume QoS.
  lastDetachDate
  TimestampRequired
  The last detach date.
  lastVmInstanceUuid
  StringRequired
  The last VM instance UUID.
- vmCdRoms
  ListRequired
  SeevmCdRoms
  uuid
  StringRequired
  The UUID of the volume.
  vmInstanceUuid
  StringRequired
  The UUID of the VM instance.
  deviceId
  IntegerRequired
  The device ID.
  isoUuid
  StringRequired
  The ISO UUID.
  isoInstallPath
  StringRequired
  The ISO install path.
  name
  StringRequired
  The name of the volume.
  description
  StringRequired
  The detailed description of the volume.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.

Request Example

Conversion Warnings

python: command should begin with "curl" but instead begins with "-H" -H "Authorization: OAuth {sessionUuid}" ^^
javascript: command should begin with "curl" but instead begins with "-H" -H "Authorization: OAuth {sessionUuid}" ^^
java: command should begin with "curl" but instead begins with "-H" -H "Authorization: OAuth {sessionUuid}" ^^
go: command should begin with "curl" but instead begins with "-H" -H "Authorization: OAuth {sessionUuid}" ^^

curl -X POST '{host}/zstack/v1/vm-instances/from/vm-backups/{groupUuid}' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "backupStorageUuid": "{backupStorageUuid}",
    "instanceOfferingUuid": "{instanceOfferingUuid}",
    "l3NetworkUuids": [
      "{l3NetworkUuids}"
    ],
    "vmNicParams": "{vmNicParams}",
    "type": "{type}",
    "zoneUuid": "{zoneUuid}",
    "clusterUuid": "{clusterUuid}",
    "hostUuid": "{hostUuid}",
    "primaryStorageUuidForRootVolume": "{primaryStorageUuidForRootVolume}",
    "primaryStorageUuidForDataVolume": "{primaryStorageUuidForDataVolume}",
    "description": "{description}",
    "rootVolumeSystemTags": [
      "{rootVolumeSystemTags}"
    ],
    "dataVolumeSystemTags": [
      "{dataVolumeSystemTags}"
    ],
    "defaultL3NetworkUuid": "{defaultL3NetworkUuid}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ],
    "strategy": "{strategy}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "uuid": "a1c07d683f693f6e9f2d7f9a499c7840",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "1e48b41ec4b63660b38a72d271c0164b",
    "clusterUuid": "f29498f04b1e3c319bdaeb6b3f8259f3",
    "imageUuid": "5c07704333c532e8b402b6b3ddb89315",
    "hostUuid": "e18cf66eedb3306686a1d4685bbb63af",
    "lastHostUuid": "4834161c409a34b6a84e40d71d85f714",
    "instanceOfferingUuid": "f53ad9f147203b499dfbd93ce41b7a8e",
    "rootVolumeUuid": "24b9fcb69f123ad6b3ddfffed96d2882",
    "platform": "Linux",
    "defaultL3NetworkUuid": "d50554f493153be78f6740e18e598046",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "9856d36e40783d669b9e4f1de41d1a17",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "usedIpUuid": "be02105c2a223492a91fb09ba664ecb1",
        "l3NetworkUuid": "d50554f493153be78f6740e18e598046",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "24b9fcb69f123ad6b3ddfffed96d2882",
        "name": "Root-Volume-For-VM-a1c07d683f693f6e9f2d7f9a499c7840",
        "primaryStorageUuid": "ae47a25fd7cf3a349035d01060a8a224",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "rootImageUuid": "5c07704333c532e8b402b6b3ddb89315",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-24b9fcb69f123ad6b3ddfffed96d2882/24b9fcb69f123ad6b3ddfffed96d2882.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-08-12
AddedResponse fields isoInstallPath, isoUuid
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