CreateVmInstanceFromOvf

POST/zstack/v1/ovf/create-vm-instance

Operation ID

CreateVmInstanceFromOvf

Since

4.4.6

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

Body Fields

paramsstructure
ObjectRequired
paramsstructure request body object.
- xmlBase64
  StringRequired
  The resource name.
- jsonImageInfos
  StringRequired
  The JSON string that describes the relationship between disk ID and the image file.
- backupStorageUuid
  StringRequired
  The UUID of the backup storage that stores the uploaded image file.
- jsonCreateVmParam
  StringRequired
  The JSON string that contains the parameters used to create a VM instance.
- deleteImageAfterSuccess
  boolean
  Optional. Specifies whether to delete the image file after the deployment is completed.
- deleteImageOnFail
  boolean
  Optional. Specifies whether to delete the image file after the deployment fails.
- resourceUuid
  String
  Optional. The resource UUID.
- tagUuids
  List
  Optional. The tag UUIDs.
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 resource UUID.
- name
  StringRequired
  The resource name.
- description
  StringRequired
  The resource description.
- 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 time.
- lastOpDate
  TimestampRequired
  The last operation time.
- state
  StringRequired
  The resource state.
- guestOsType
  StringRequired
  The guest OS type.
- vmNics
  ListRequired
  See vmNics.
  uuid
  StringRequired
  The resource UUID.
  vmInstanceUuid
  StringRequired
  The VM UUID.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  ip
  StringRequired
  The IP address.
  mac
  StringRequired
  The MAC address.
  hypervisorType
  StringRequired
  The hypervisor type.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway.
  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 NIC type.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.
  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 NIC UUID.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.
- allVolumes
  ListRequired
  See allVolumes.
  uuid
  StringRequired
  The resource UUID.
  name
  StringRequired
  The resource name.
  description
  StringRequired
  The resource description.
  primaryStorageUuid
  StringRequired
  The primary storage UUID.
  vmInstanceUuid
  StringRequired
  The VM UUID.
  diskOfferingUuid
  StringRequired
  The disk offering UUID.
  rootImageUuid
  StringRequired
  The root volume image UUID.
  installPath
  StringRequired
  The installation path.
  type
  StringRequired
  The volume type.
  format
  StringRequired
  The volume format.
  size
  LongRequired
  The virtual size of the volume.
  actualSize
  LongRequired
  The actual size of the volume.
  deviceId
  IntegerRequired
  The device ID.
  state
  StringRequired
  The state of the volume.
  status
  StringRequired
  The status of the volume.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.
  isShareable
  BooleanRequired
  Whether the volume can be shared.
  volumeQos
  StringRequired
  The volume QoS.
- vmCdRoms
  ListRequired
  See vmCdRoms.
  uuid
  StringRequired
  The resource UUID.
  vmInstanceUuid
  StringRequired
  The VM UUID.
  deviceId
  IntegerRequired
  The device ID.
  isoUuid
  StringRequired
  The ISO UUID.
  isoInstallPath
  StringRequired
  The ISO install path.
  name
  StringRequired
  The resource name.
  description
  StringRequired
  The resource description.
  createDate
  TimestampRequired
  The creation time.
  lastOpDate
  TimestampRequired
  The last operation time.

Request Example

curl -X POST '{host}/zstack/v1/ovf/create-vm-instance' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "paramsstructure": {
    "xmlBase64": "{xmlBase64}",
    "jsonImageInfos": "{jsonImageInfos}",
    "backupStorageUuid": "{backupStorageUuid}",
    "jsonCreateVmParam": "{jsonCreateVmParam}",
    "deleteImageAfterSuccess": "{deleteImageAfterSuccess}",
    "deleteImageOnFail": "{deleteImageOnFail}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "uuid": "ef8b74d3a7f931c3aacf258c20d25411",
    "name": "test-ovf",
    "description": "web server VM",
    "zoneUuid": "5f3cdedd4a823bfcadd45385f034b763",
    "clusterUuid": "2bb23d2c0a013338add7cedf2615ac39",
    "imageUuid": "f47e5dbf886e3d16b8097294efd63b37",
    "hostUuid": "82bad7cada82377684459e59292937b4",
    "lastHostUuid": "00e742c03afe3cd68234aa9c9352d5a7",
    "instanceOfferingUuid": "a9a166f625e23886a7227bdb472da645",
    "rootVolumeUuid": "3e92e577418835a3bfeb0d770e898052",
    "platform": "Linux",
    "defaultL3NetworkUuid": "e4f37ede6e563fe5943ae8b8c7c008d6",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 4294967296,
    "cpuNum": 4,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "d5a26fdfdcff30748b22b85f4d7fadbe",
        "vmInstanceUuid": "ef8b74d3a7f931c3aacf258c20d25411",
        "usedIpUuid": "4423412a12653cb3af73231e16e526cf",
        "l3NetworkUuid": "e4f37ede6e563fe5943ae8b8c7c008d6",
        "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,
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "3e92e577418835a3bfeb0d770e898052",
        "name": "Root-Volume-For-VM-ef8b74d3a7f931c3aacf258c20d25411",
        "primaryStorageUuid": "353a440b83283acca73e3d3fd2cca0c5",
        "vmInstanceUuid": "ef8b74d3a7f931c3aacf258c20d25411",
        "diskOfferingUuid": "323969fdd2273f1a8e42aef10a9e8c6b",
        "rootImageUuid": "f47e5dbf886e3d16b8097294efd63b37",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-3e92e577418835a3bfeb0d770e898052/3e92e577418835a3bfeb0d770e898052.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ]
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-09-23
AddedRequest body fields paramsstructure
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