DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›API ReferenceZCF

ProvisionSlbInstance

API Request

URLs
PUT zstack/v1/load-balancers/slb/instances/{uuid}/provision
Headers
Authorization: OAuth the-session-uuid
Body
{
  "provisionSlbInstance": {},
  "systemTags": [],
  "userTags": []
}
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"provisionSlbInstance":{}}' http://localhost:8080/zstack/v1/load-balancers/slb/instances/0540bae0537334d7a71f13316444f53a/provision
Request Parameters
Name Type Location Description Optional Value Starting Version
slbInstanceUuid String body(contained in the provisionSlbInstance structure) 5.1.0
systemTags List query Optional. The system tags. 5.1.0
userTags List query Optional. The user tags. 5.1.0

API Response

Sample Response
{
  "inventory": {
    "name": "slb",
    "backendType": "vyos",
    "deployType": "NoHA",
    "description": "slb test"
  }
}
Name Type Description Starting Version
success boolean 5.1.0
inventory CertificateInventory See inventory. 5.1.0
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 5.1.0
#inventory
Name Type Description Starting Version
uuid String The UUID of the resource. 5.1.0
name String The name of the resource. 5.1.0
backendType String The backend type. 5.1.0
deployType String The deploy type. 5.1.0
slbOfferingUuid String The slb offering UUID. 5.1.0
description String The detailed description of the resource. 5.1.0
configVersion Long The config version. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
slbVms List See slbVms. 5.1.0
lbs List See lbs. 5.1.0
networks List See networks. 5.1.0
monitorIps List See monitorIps. 5.1.0
#slbVms
Name Type Description Starting Version
slbGroupUuid String 5.1.0
configVersion String 5.1.0
publicNetworkUuid String 5.1.0
virtualRouterVips List 5.1.0
applianceVmType String 5.1.0
managementNetworkUuid String 5.1.0
defaultRouteL3NetworkUuid String 5.1.0
status String 5.1.0
agentPort Integer 5.1.0
haStatus String 5.1.0
uuid String The resource UUID. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
zoneUuid String The zone UUID. 5.1.0
clusterUuid String The cluster UUID. 5.1.0
imageUuid String The image UUID. 5.1.0
hostUuid String The host UUID. 5.1.0
lastHostUuid String 5.1.0
instanceOfferingUuid String The instance offering UUID. 5.1.0
rootVolumeUuid String The root volume UUID. 5.1.0
platform String 5.1.0
architecture String 5.1.0
defaultL3NetworkUuid String 5.1.0
type String 5.1.0
hypervisorType String 5.1.0
memorySize Long 5.1.0
reservedMemorySize Long 5.1.0
cpuNum Integer 5.1.0
cpuSpeed Long 5.1.0
allocatorStrategy String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
state String 5.1.0
guestOsType String 5.1.0
configTasks List See configTasks 5.1.0
vmNics List See vmNics 5.1.0
allVolumes List See allVolumes 5.1.0
vmCdRoms List See vmCdRoms 5.1.0
#configTasks
Name Type Description Starting Version
vmInstanceUuid String The VM instance UUID. 5.1.0
configVersion long 5.1.0
taskName String 5.1.0
taskData String 5.1.0
retryNumber long 5.1.0
lastFailedReason String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
status SlbVmInstanceConfigTaskStatus See status 5.1.0
#status
Name Type Description Starting Version
Pending SlbVmInstanceConfigTaskStatus 5.1.0
Starting SlbVmInstanceConfigTaskStatus 5.1.0
Success SlbVmInstanceConfigTaskStatus 5.1.0
Failed SlbVmInstanceConfigTaskStatus 5.1.0
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
l3NetworkUuid String The L3 network UUID 5.1.0
ip String 5.1.0
mac String 5.1.0
hypervisorType String 5.1.0
netmask String 5.1.0
gateway String 5.1.0
metaData String 5.1.0
ipVersion 5.1.0
driverType String 5.1.0
internalName String 5.1.0
deviceId 5.1.0
type String 5.1.0
state String The vmNic state. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
usedIps List See usedIps. 5.1.0
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
ipRangeUuid String The ip range UUID 5.1.0
l3NetworkUuid String The L3 network UUID. 5.1.0
ipVersion Integer 5.1.0
ip String 5.1.0
netmask String 5.1.0
gateway String 5.1.0
usedFor String 5.1.0
ipInLong long 5.1.0
vmNicUuid String The vmNic UUID. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
primaryStorageUuid String The primary storage UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
diskOfferingUuid String The disk offering UUID. 5.1.0
rootImageUuid String 5.1.0
installPath String 5.1.0
type String 5.1.0
format String 5.1.0
size Long 5.1.0
actualSize Long 5.1.0
deviceId Integer 5.1.0
state String 5.1.0
status String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
isShareable Boolean 5.1.0
volumeQos String 5.1.0
lastDetachDate Timestamp 5.1.0
lastVmInstanceUuid String 5.1.0
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
deviceId Integer 5.1.0
isoUuid String 5.1.0
isoInstallPath String 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#lbs
Name Type Description Starting Version
slbGroupUuid String 5.1.0
name String The resource name. 5.1.0
uuid String The resource UUID. 5.1.0
description String The detailed description of the resource. 5.1.0
serverGroupUuid String 5.1.0
state String 5.1.0
type String 5.1.0
vipUuid String VIP UUID. 5.1.0
ipv6VipUuid String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
listeners List See listeners 5.1.0
#listeners
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
loadBalancerUuid String The load balancer UUID. 5.1.0
instancePort Integer 5.1.0
loadBalancerPort Integer 5.1.0
protocol String 5.1.0
serverGroupUuid String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
vmNicRefs List See vmNicRefs 5.1.0
aclRefs List See aclRefs 5.1.0
certificateRefs List See certificateRefs 5.1.0
serverGroupRefs List See serverGroupRefs 5.1.0
#vmNicRefs
Name Type Description Starting Version
id Long 5.1.0
listenerUuid String 5.1.0
vmNicUuid String The vmNic UUID. 5.1.0
status String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#aclRefs
Name Type Description Starting Version
id Long The resource UUID. 5.1.0
listenerUuid String The listener UUID. 5.1.0
aclUuid String The acl UUID. 5.1.0
type String The type. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#certificateRefs
Name Type Description Starting Version
id Long 5.1.0
listenerUuid String 5.1.0
certificateUuid String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#serverGroupRefs
Name Type Description Starting Version
id Long 5.1.0
listenerUuid String 5.1.0
serverGroupUuid String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#networks
Name Type Description Starting Version
slbGroupUuid String 5.1.0
l3NetworkUuid String The L3 network UUID. 5.1.0
l3NetworkCategory String 5.1.0
l3NetworkType String 5.1.0
type String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#monitorIps
Name Type Description Starting Version
id Long 5.1.0
slbGroupUuid String 5.1.0
monitorIp String 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 5.1.0
description String The brief description of the error. 5.1.0
details String The details about the error. 5.1.0
elaboration String The reserved field. Default value: null. 5.1.0
opaque LinkedHashMap The reserved field. Default value: null. 5.1.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 5.1.0

SDK Sample

Java SDK
GetLoadBalancerOwnerAction action = new GetLoadBalancerOwnerAction();
action.loadBalancerUuid = "01a14d335cec36a7b0c36bedc8181465";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetLoadBalancerOwnerAction.Result res = action.call();
Python SDK
GetLoadBalancerOwnerAction action = GetLoadBalancerOwnerAction()
action.loadBalancerUuid = "01a14d335cec36a7b0c36bedc8181465"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetLoadBalancerOwnerAction.Result res = action.call()
PreviousGetLoadBalancerOwnerNextChangeSlbGroupDeployType
API Reference | 5.4.12 | ZStack Cloud · ZCF | ZStack Resource Center