文档目录

修改负载均衡监听器下后端服务器的启用状态。仅支持由 openEuler VPC 路由器提供的负载均衡和 openEuler 性能独享型负载均衡(独立 SLB),不支持 VyOS。(ChangeLoadBalancerListenerBackendServerState)

API请求

URLs
PUT zstack/v1/load-balancers/listeners/{listenerUuid}/servergroups/{serverGroupUuid}/backendservers/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeLoadBalancerListenerBackendServerState": {
    "vmNicUuids": [
      "acd56cea809e3403b709cf8530575add"
    ],
    "state": "Disabled"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeLoadBalancerListenerBackendServerState":{"vmNicUuids":["acd56cea809e3403b709cf8530575add"],"state":"Disabled"}}' \
http://localhost:8080/zstack/v1/load-balancers/listeners/c4400f26d55c37dcbb4b538cb1e8b5ef/servergroups/4b3f55b00c153a7f8ab3c86daf45ed1a/backendservers/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
listenerUuid String url 负载均衡监听器UUID 5.5.38
serverGroupUuid String url 后端服务器组UUID 5.5.38
vmNicUuids (可选) List body(包含在changeLoadBalancerListenerBackendServerState结构中) 当前后端服务器组中需要启用或停用的云主机网卡UUID列表 5.5.38
serverIps (可选) List body(包含在changeLoadBalancerListenerBackendServerState结构中) 当前后端服务器组中需要启用或停用的IP地址列表;仅性能独享型负载均衡支持,且与vmNicUuids至少一个非空 5.5.38
state String body(包含在changeLoadBalancerListenerBackendServerState结构中) 本次批量操作的目标管理态
  • Enabled
  • Disabled
5.5.38
systemTags (可选) List body 系统标签 5.5.38
userTags (可选) List body 用户标签 5.5.38

API返回

返回示例
{
  "results": [
    {
      "backendType": "VmNic",
      "vmNicUuid": "926709422db736adb32b9d208afb6648",
      "targetState": "Disabled",
      "effectiveState": "Disabled"
    }
  ]
}
名字 类型 描述 起始版本
success boolean 操作是否成功 5.5.38
error ErrorCode 错误码,若不为null,则表示操作失败,操作成功时该字段为null。 详情参考error 5.5.38
results List 详情参考results 5.5.38
#results
名字 类型 描述 起始版本
backendType String 后端服务器类型,取值为VmNic或ServerIp 5.5.38
vmNicUuid String 云主机网卡UUID 5.5.38
serverIp String 后端服务器IP地址 5.5.38
targetState String 请求设置的目标管理态 5.5.38
effectiveState String 实际生效的管理态 5.5.38
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如 SYS.1000、HOST.1001 5.3.20
description String 错误的概要描述 5.3.20
details String 错误的详细信息 5.3.20
elaboration String 保留字段,默认为null 5.3.20
opaque LinkedHashMap 保留字段,默认为null 5.3.20
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 5.3.20

SDK示例

Java SDK
ChangeLoadBalancerListenerBackendServerStateAction action = new ChangeLoadBalancerListenerBackendServerStateAction();
action.listenerUuid = "c4400f26d55c37dcbb4b538cb1e8b5ef";
action.serverGroupUuid = "4b3f55b00c153a7f8ab3c86daf45ed1a";
action.vmNicUuids = asList("acd56cea809e3403b709cf8530575add");
action.state = "Disabled";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeLoadBalancerListenerBackendServerStateAction.Result res = action.call();
Python SDK
action = ChangeLoadBalancerListenerBackendServerStateAction()
action.listenerUuid = "c4400f26d55c37dcbb4b538cb1e8b5ef"
action.serverGroupUuid = "4b3f55b00c153a7f8ab3c86daf45ed1a"
action.vmNicUuids = ["acd56cea809e3403b709cf8530575add"]
action.state = "Disabled"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
开发手册 | 5.5.38 | ZStack Cloud · ZCF | ZStack 资源中心