文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

配置负载均衡实例(ProvisionSlbInstance)

API请求

URLs
PUT zstack/v1/load-balancers/slb/instances/{uuid}/provision
Headers
Authorization: OAuth the-session-uuid
Body
{
  "provisionSlbInstance": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
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
参数列表
名字 类型 位置 描述 可选值 起始版本
slbInstanceUuid String body(包含在provisionSlbInstance结构中) 5.1.0
systemTags (可选) List body 系统标签 5.1.0
userTags (可选) List body 用户标签 5.1.0

API返回

返回示例
{
  "inventory": {
    "name": "slb",
    "backendType": "vyos",
    "deployType": "NoHA",
    "description": "slb test"
  }
}
名字 类型 描述 起始版本
success boolean 5.1.0
inventory CertificateInventory 详情参考inventory 5.1.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 5.1.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
name String 资源名称 5.1.0
backendType String 实例镜像类型 5.1.0
deployType String 部署方式 5.1.0
slbOfferingUuid String 实例规格
description String 资源的详细描述 5.1.0
configVersion Long 配置版本 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
slbVms List 详情参考slbVms 5.1.0
lbs List 详情参考lbs 5.1.0
networks List 详情参考networks 5.1.0
monitorIps List 详情参考monitorIps 5.1.0
#slbVms
名字 类型 描述 起始版本
slbGroupUuid String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.1.0
configVersion long 错误的概要描述 5.1.0
publicNetworkUuid String 错误的详细信息 5.1.0
virtualRouterVips List 保留字段，默认为null 5.1.0
applianceVmType String 保留字段，默认为null 5.1.0
managementNetworkUuid String 根错误，引发当前错误的源错误，若无原错误，该字段为null 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 资源的UUID，唯一标示该资源 5.1.0
name String 资源名称 5.1.0
description String 资源的详细描述 5.1.0
zoneUuid String 区域UUID 5.1.0
clusterUuid String 集群UUID 5.1.0
imageUuid String 镜像UUID 5.1.0
hostUuid String 物理机UUID 5.1.0
lastHostUuid String 5.1.0
instanceOfferingUuid String 计算规格UUID 5.1.0
rootVolumeUuid String 根云盘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 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
state String 5.1.0
guestOsType String 5.1.0
configTasks List 详情参考configTasks 5.1.0
vmNics List 详情参考vmNics 5.1.0
allVolumes List 详情参考allVolumes 5.1.0
vmCdRoms List 详情参考vmCdRoms 5.1.0
#configTasks
名字 类型 描述 起始版本
vmInstanceUuid String 云主机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 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
status SlbVmInstanceConfigTaskStatus 详情参考status 5.1.0
#status
名字 类型 描述 起始版本
Pending SlbVmInstanceConfigTaskStatus 5.1.0
Starting SlbVmInstanceConfigTaskStatus 5.1.0
Success SlbVmInstanceConfigTaskStatus 5.1.0
Failed SlbVmInstanceConfigTaskStatus 5.1.0
#vmNics
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
vmInstanceUuid String 云主机UUID 5.1.0
l3NetworkUuid String 三层网络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 Integer 5.1.0
driverType String 5.1.0
internalName String 5.1.0
deviceId Integer 5.1.0
type String 5.1.0
state String 网卡状态 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
usedIps List 详情参考usedIps 5.1.0
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
ipRangeUuid String IP段UUID 5.1.0
l3NetworkUuid String 三层网络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 云主机网卡UUID 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#allVolumes
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
name String 资源名称 5.1.0
description String 资源的详细描述 5.1.0
primaryStorageUuid String 主存储UUID 5.1.0
vmInstanceUuid String 云主机UUID 5.1.0
diskOfferingUuid String 云盘规格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 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
isShareable Boolean 5.1.0
volumeQos String 5.1.0
lastDetachDate Timestamp 5.1.0
lastVmInstanceUuid String 5.1.0
#vmCdRoms
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
vmInstanceUuid String 云主机UUID 5.1.0
deviceId Integer 5.1.0
isoUuid String 5.1.0
isoInstallPath String 5.1.0
name String 资源名称 5.1.0
description String 资源的详细描述 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#lbs
名字 类型 描述 起始版本
slbGroupUuid String 5.1.0
name String 资源名称 5.1.0
uuid String 资源的UUID，唯一标示该资源 5.1.0
description String 资源的详细描述 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 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
listeners List 详情参考listeners 5.1.0
#listeners
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
name String 资源名称 5.1.0
description String 资源的详细描述 5.1.0
loadBalancerUuid String 负载均衡器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 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
vmNicRefs List 详情参考vmNicRefs 5.1.0
aclRefs List 详情参考aclRefs 5.1.0
certificateRefs List 详情参考certificateRefs 5.1.0
serverGroupRefs List 详情参考serverGroupRefs 5.1.0
#vmNicRefs
名字 类型 描述 起始版本
id Long 5.1.0
listenerUuid String 5.1.0
vmNicUuid String 云主机网卡UUID 5.1.0
status String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#aclRefs
名字 类型 描述 起始版本
id Long 资源唯一标识 5.1.0
listenerUuid String 监听器唯一标识 5.1.0
aclUuid String 访问策略组唯一标识 5.1.0
type String 访问策略类型 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#certificateRefs
名字 类型 描述 起始版本
id Long 5.1.0
listenerUuid String 5.1.0
certificateUuid String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#serverGroupRefs
名字 类型 描述 起始版本
id Long 5.1.0
listenerUuid String 5.1.0
serverGroupUuid String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#networks
名字 类型 描述 起始版本
slbGroupUuid String 5.1.0
l3NetworkUuid String 三层网络UUID 5.1.0
l3NetworkCategory String 5.1.0
l3NetworkType String 5.1.0
type String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#monitorIps
名字 类型 描述 起始版本
id Long 5.1.0
slbGroupUuid String 5.1.0
monitorIp String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.1.0
description String 错误的概要描述 5.1.0
details String 错误的详细信息 5.1.0
elaboration String 保留字段，默认为null 5.1.0
opaque LinkedHashMap 保留字段，默认为null 5.1.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 5.1.0

SDK示例

Java SDK
ProvisionSlbInstanceAction action = new ProvisionSlbInstanceAction();
action.uuid = "0540bae0537334d7a71f13316444f53a";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ProvisionSlbInstanceAction.Result res = action.call();
Python SDK
ProvisionSlbInstanceAction action = ProvisionSlbInstanceAction()
action.uuid = "0540bae0537334d7a71f13316444f53a"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ProvisionSlbInstanceAction.Result res = action.call()
上一篇获取负载均衡所属资源(GetLoadBalancerOwner)下一篇创建SLB集群(CreateSlbGroup)
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心