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

更新性能独享型负载均衡器组(UpdateSlbGroup)

API请求

URLs
PUT zstack/v1/load-balancers/slb/group/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateSlbGroup": {
    "name": "slb",
    "description": "slb test",
    "slbOfferingUuid": "3996416dcab833258087ac86be993858"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSlbGroup":{"name":"slb","description":"slb test","slbOfferingUuid":"3996416dcab833258087ac86be993858"}}' http://localhost:8080/zstack/v1/load-balancers/slb/group/fa13412281f333469e8009c531ef9755/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 4.0.0
name (可选) String body(包含在updateSlbGroup结构中) 资源名称 4.0.0
description (可选) String body(包含在updateSlbGroup结构中) 资源的详细描述 4.0.0
slbOfferingUuid (可选) String body(包含在updateSlbGroup结构中) 性能独享型负载均衡器规格 4.0.0
systemTags (可选) List body 系统标签 4.0.0
userTags (可选) List body 用户标签 4.0.0

API返回

返回示例
{
  "inventory": {
    "name": "slb",
    "backendType": "vyos",
    "deployType": "direct",
    "description": "slb test"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.0.0
inventory SlbGroupInventory 详情参考inventory 4.0.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.0.0
description String 错误的概要描述 4.0.0
details String 错误的详细信息 4.0.0
elaboration String 保留字段，默认为null 4.0.0
opaque LinkedHashMap 保留字段，默认为null 4.0.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.0.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
name String 资源名称 4.0.0
backendType String 4.0.0
deployType String 4.0.0
slbOfferingUuid String 4.0.0
description String 资源的详细描述 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
slbVms List 详情参考slbVms 4.0.0
lbs List 详情参考lbs 4.0.0
networks List 详情参考networks 4.0.0
#slbVms
名字 类型 描述 起始版本
slbGroupUuid String 4.0.0
publicNetworkUuid String 4.0.0
virtualRouterVips List 4.0.0
applianceVmType String 4.0.0
managementNetworkUuid String 4.0.0
defaultRouteL3NetworkUuid String 4.0.0
status String 4.0.0
agentPort Integer 4.0.0
haStatus String 4.0.0
uuid String 资源的UUID，唯一标示该资源 4.0.0
name String 资源名称 4.0.0
description String 资源的详细描述 4.0.0
zoneUuid String 区域UUID 4.0.0
clusterUuid String 集群UUID 4.0.0
imageUuid String 镜像UUID 4.0.0
hostUuid String 物理机UUID 4.0.0
lastHostUuid String 4.0.0
instanceOfferingUuid String 计算规格UUID 4.0.0
rootVolumeUuid String 根云盘UUID 4.0.0
platform String 4.0.0
defaultL3NetworkUuid String 4.0.0
type String 4.0.0
hypervisorType String 4.0.0
memorySize Long 4.0.0
cpuNum Integer 4.0.0
cpuSpeed Long 4.0.0
allocatorStrategy String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
state String 4.0.0
vmNics List 详情参考vmNics 4.0.0
allVolumes List 详情参考allVolumes 4.0.0
vmCdRoms List 详情参考vmCdRoms 4.0.0
#vmNics
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
vmInstanceUuid String 云主机UUID 4.0.0
l3NetworkUuid String 三层网络UUID 4.0.0
ip String IP地址 4.0.0
mac String MAC地址 4.0.0
hypervisorType String 虚拟化类型 4.0.0
netmask String 子网掩码 4.0.0
gateway String 网关 4.0.0
metaData String 4.0.0
ipVersion Integer IP地址版本 4.0.0
deviceId Integer 设备ID 4.0.0
type String 网卡类型 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
usedIps List 详情参考usedIps 4.0.0
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
ipRangeUuid String IP段UUID 4.0.0
l3NetworkUuid String 三层网络UUID 4.0.0
ipVersion Integer IP协议号 4.0.0
ip String IP地址 4.0.0
netmask String 网络掩码 4.0.0
gateway String 网关地址 4.0.0
usedFor String 4.0.0
ipInLong long 4.0.0
vmNicUuid String 云主机网卡UUID 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#allVolumes
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
name String 资源名称 4.0.0
description String 资源的详细描述 4.0.0
primaryStorageUuid String 主存储UUID 4.0.0
vmInstanceUuid String 云主机UUID 4.0.0
diskOfferingUuid String 云盘规格UUID 4.0.0
rootImageUuid String 云盘根镜像UUID 4.0.0
installPath String 云盘在主存储上的路径 4.0.0
type String 云盘类型，数据云盘/根云盘 4.0.0
format String 云盘格式 4.0.0
size Long 云盘大小 4.0.0
actualSize Long 云盘真实大小 4.0.0
deviceId Integer 4.0.0
state String 云盘是否开启 4.0.0
status String 云盘状态 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
isShareable Boolean 是否共享云盘 4.0.0
volumeQos String 云盘Qos，格式如total=1048576 4.0.0
#vmCdRoms
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
vmInstanceUuid String 云主机UUID 4.0.0
deviceId Integer 光驱顺序号 4.0.0
isoUuid String ISO镜像UUID 4.0.0
isoInstallPath String ISO镜像挂载路径 4.0.0
name String 资源名称 4.0.0
description String 资源的详细描述 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#lbs
名字 类型 描述 起始版本
slbGroupUuid String 4.0.0
name String 资源名称 4.0.0
uuid String 资源的UUID，唯一标示该资源 4.0.0
description String 资源的详细描述 4.0.0
state String 4.0.0
type String 4.0.0
vipUuid String VIP UUID 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
listeners List 详情参考listeners 4.0.0
#listeners
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.0.0
name String 资源名称 4.0.0
description String 资源的详细描述 4.0.0
loadBalancerUuid String 负载均衡器UUID 4.0.0
instancePort Integer 4.0.0
loadBalancerPort Integer 4.0.0
protocol String 4.0.0
serverGroupUuid String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
vmNicRefs List 详情参考vmNicRefs 4.0.0
aclRefs List 详情参考aclRefs 4.0.0
certificateRefs List 详情参考certificateRefs 4.0.0
serverGroupRefs List 详情参考serverGroupRefs 4.0.0
#vmNicRefs
名字 类型 描述 起始版本
id Long 4.0.0
listenerUuid String 4.0.0
vmNicUuid String 云主机网卡UUID 4.0.0
status String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#aclRefs
名字 类型 描述 起始版本
id Long 资源唯一标识 4.0.0
listenerUuid String 监听器唯一标识 4.0.0
aclUuid String 访问策略组唯一标识 4.0.0
type String 访问策略类型 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#certificateRefs
名字 类型 描述 起始版本
id Long 4.0.0
listenerUuid String 4.0.0
certificateUuid String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#serverGroupRefs
名字 类型 描述 起始版本
id long 4.0.0
listenerUuid String 4.0.0
serverGroupUuid String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0
#networks
名字 类型 描述 起始版本
slbGroupUuid String 4.0.0
l3NetworkUuid String 三层网络UUID 4.0.0
l3NetworkCategory String 4.0.0
l3NetworkType String 4.0.0
type String 4.0.0
createDate Timestamp 创建时间 4.0.0
lastOpDate Timestamp 最后一次修改时间 4.0.0

SDK示例

Java SDK
UpdateSlbGroupAction action = new UpdateSlbGroupAction();
action.uuid = "fa13412281f333469e8009c531ef9755";
action.name = "slb";
action.description = "slb test";
action.slbOfferingUuid = "3996416dcab833258087ac86be993858";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSlbGroupAction.Result res = action.call();
Python SDK
UpdateSlbGroupAction action = UpdateSlbGroupAction()
action.uuid = "fa13412281f333469e8009c531ef9755"
action.name = "slb"
action.description = "slb test"
action.slbOfferingUuid = "3996416dcab833258087ac86be993858"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSlbGroupAction.Result res = action.call()
上一篇删除性能独享型负载均衡器组(DeleteSlbGroup)下一篇查询性能独享型负载均衡器组(QuerySlbGroup)
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心