CreateSlbInstance

POST/zstack/v1/load-balancers/slb/instances

Operation ID

CreateSlbInstance

Since

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

This API requires no request parameters.

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
SlbVmInstanceInventoryRequired
See inventory.
- slbGroupUuid
  StringRequired
  The slb group UUID.
- configVersion
  longRequired
  The config version.
- publicNetworkUuid
  StringRequired
  The public network UUID.
- virtualRouterVips
  ListRequired
  The virtual router vips.
- applianceVmType
  StringRequired
  The appliance VM instance type.
- managementNetworkUuid
  StringRequired
  The management network UUID.
- defaultRouteL3NetworkUuid
  StringRequired
  The default route L3 network UUID.
- status
  StringRequired
  The resource status.
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
- agentPort
  IntegerRequired
  The agent port.
- haStatus
  StringRequired
  The HA status.
- uuid
  StringRequired
  The 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.
- reservedMemorySize
  LongRequired
  The reserved 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.
- configTasks
  ListRequired
  See configTasks.
  vmInstanceUuid
  StringRequired
  The VM instance Uuid.
  configVersion
  longRequired
  The config version.
  taskName
  StringRequired
  The task name.
  taskData
  StringRequired
  The task data.
  retryNumber
  longRequired
  The number of retry.
  lastFailedReason
  StringRequired
  The last failed reason.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last creation date.
  status
  SlbVmInstanceConfigTaskStatusRequired
  See status.
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
- vmNics
  ListRequired
  See vmNics.
  uuid
  StringRequired
  The NIC UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  ip
  StringRequired
  The IP address of the NIC.
  mac
  StringRequired
  The MAC address of the NIC.
  hypervisorType
  StringRequired
  The virtualization type.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  metaData
  StringRequired
  The metadata.
  ipVersion
  IntegerRequired
  The IP version.
  deviceId
  IntegerRequired
  The device ID.
  type
  StringRequired
  The NIC type.
  state
  StringRequired
  The NIC state.
  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 IP address 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 IP address.
  usedFor
  StringRequired
  The intended use.
  ipInLong
  longRequired
  The IP address represented as a long integer.
  ipInBinary
  byte[]Required
  The IP in binary.
  vmNicUuid
  StringRequired
  The VM Nic Uuid.
  createDate
  TimestampRequired
  The time when the IP address was used.
  lastOpDate
  TimestampRequired
  The time when the was last modified.
- allVolumes
  ListRequired
  See allVolumes.
  uuid
  StringRequired
  The volume UUID.
  name
  StringRequired
  The volume name.
  description
  StringRequired
  The detailed description of the volume.
  primaryStorageUuid
  StringRequired
  The primary storage UUID.
  vmInstanceUuid
  StringRequired
  The bare metal instance UUID.
  diskOfferingUuid
  StringRequired
  The volume offering UUID.
  rootImageUuid
  StringRequired
  The root image UUID.
  installPath
  StringRequired
  The installation path of the volume in the primary storage.
  type
  StringRequired
  The type of the volume.
  format
  StringRequired
  The format of the volume.
  size
  LongRequired
  The size of the volume.
  actualSize
  LongRequired
  The actual storage space that the volume takes up.
  deviceId
  IntegerRequired
  The device ID.
  state
  StringRequired
  The state of the volume.
  status
  StringRequired
  The status of the volume.
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
  createDate
  TimestampRequired
  The time when the volume was created.
  lastOpDate
  TimestampRequired
  The time when the volume was last modified.
  isShareable
  BooleanRequired
  Indicates whether the volume is shareable.
  volumeQos
  StringRequired
  The QoS of the volume, for example, 1048576.
  lastDetachDate
  TimestampRequired
  The last detach date.
  lastVmInstanceUuid
  StringRequired
  The last VM instance UUID.
- vmCdRoms
  ListRequired
  See vmCdRoms.
  uuid
  StringRequired
  The CD-ROM UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  deviceId
  IntegerRequired
  The device ID.
  isoUuid
  StringRequired
  The ISO image UUID.
  isoInstallPath
  StringRequired
  The installation path of the ISO image.
  name
  StringRequired
  The CD-ROM name.
  description
  StringRequired
  The detailed description of the CD-ROM.
  createDate
  TimestampRequired
  The time when the CD-ROM was created.
  lastOpDate
  TimestampRequired
  The time when the CD-ROM was last modified.

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-09-23
DeletedRequest body fields clusterUuid, description, hostUuid...
View API
Change Time
2026-08-12
AddedRequest body fields clusterUuid, description, hostUuid...
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