文档目录

负载均衡

创建负载均衡器(CreateLoadBalancer)

管理员可以使用CreateLoadBalancer创建负载均衡器。例如:
CreateLoadBalancer name=LB1 vipUuid=dc0ee73ed875423aa6778fc091e3ce70

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 负载均衡器名称 0.6
description 负载均衡器的详细描述 0.6
vipUuid VIP的uuid 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerVO 0.6
timeout

更新负载均衡器(UpdateLoadBalancer)

管理员可以使用UpdateLoadBalancer更新负载均衡器。例如:
UpdateLoadBalancer uuid=901ddf386552467298685d08949911f8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 0.6
name 负载均衡器名称 0.6
description 负载均衡器的详细描述 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是LoadBalancerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerVO 0.6
timeout

删除负载均衡器(DeleteLoadBalancer)

管理员可以使用DeleteLoadBalancer删除负载均衡器。例如:
DeleteLoadBalancer uuid=18fa017f308342f5a580edcbb63dbeb3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 负载均衡器的uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerVO 0.6
timeout

查询负载均衡器(QueryLoadBalancer)

管理员可以使用QueryLoadBalancer查询负载均衡器。例如:
QueryLoadBalancer vipUuid=dc0ee73ed875423aa6778fc091e3ce70
QueryLoadBalancer listeners.uuid=ba50b5cd2e09461e9aea80df779c425d

原生域查询(Primitive Fields of Query)

请参见 load balancer inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
loadBalancer loadBalancer inventory 0.6
vmNic vmNic inventory 0.6
vmNicRefs vmNicRefs inventory 0.6

刷新负载均衡器(RefreshLoadBalancer)

管理员可以使用RefreshLoadBalancer刷新负载均衡器。例如:
RefreshLoadBalancer uuid=bad56001c1f24cefa085fa9cf83f6424

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 负载均衡器uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是LoadBalancerVO 0.6
timeout

创建负载均衡监听器(CreateLoadBalancerListener)

管理员可以使用CreateLoadBalancerListener创建负载均衡监听器。例如:
CreateLoadBalancerListener name=lblistener loadBalancerUuid=bad56001c1f24cefa085fa9cf83f6424\
loadBalancerPort=22 instancePort=23

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
loadBalancerUuid 负载均衡器uuid 0.6
certificateUuid 2.3
name 负载均衡监听器的名称 0.6
description 负载均衡监听器的详细描述 0.6
instancePort 云主机端口 0.6
loadBalancerPort 负载均衡器端口 0.6
protocol 协议
  • tcp
  • http
  • https
  • udp
0.6
resourceUuid 资源UUID 0.6
instancePort 3.9.0
healthCheckProtocol 健康检查协议
  • tcp
  • udp
  • http
3.9.0
healthCheckMethod 健康检查方法
  • GET
  • HEAD
3.9.0
healthCheckURI 健康检查的URI 3.9.0
healthCheckHttpCode 健康检查期望的返回码 3.9.0
aclStatus 访问控制策略状态
  • enable
  • disable
3.9.0
aclUuids 访问控制策略组 3.9.0
aclType 访问控制策略类型
  • white
  • black
3.9.0
tagUuids 标签UUID列表 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout
Note:
  • ZStack Cloud创建负载均衡监听器时支持设置7层健康检查参数,SystemTags增加healthCheckParameter选项。
    • 选项格式为:healthCheckParameter::{parameter} ,参数形如:healthCheckParameter::method:uri:expect-result
    • 例如:healthCheckParameter::GET:/healthstatus.html:http_2xx
  • ZStack Cloud创建负载均衡监听器时支持设置监听器访问控制状态,SystemTags增加accessControlStatus选项。
    • 选项格式为:accessControlStatus::{status}
    • 例如:accessControlStatus::enable
  • ZStack Cloud创建负载均衡监听器时支持指定会话保持模式及开关,SystemTags增加sessionPersistence选项。
    • 选项格式为:sessionPersistence::{%s},其中%s可以为disable/iphash/insert/rewrite
    • 例如:sessionPersistence::insert
  • ZStack Cloud创建负载均衡监听器时支持设置指定会话保持时间,SystemTags增加sessionIdleTimeout选项。
    • 选项格式为:sessionIdleTimeout::{%s},其中%s可以为30-3600
    • 例如:sessionIdleTimeout::60
  • ZStack Cloud创建负载均衡监听器时支持设置会话保持重写名称,SystemTags增加cookieName选项。
    • 选项格式为:validRegexValues::{%s},其中%s可以为"[A-Za-z0-9_-]+", maxLength = 20
    • 例如:cookieName::zstack-cookie
  • ZStack Cloud支持设置是否开启HTTP重定向,SystemTags增加httpRedirectHttps选项。
    • 选项格式为:httpRedirectHttps::{%s},其中%s可以为disable/enable
    • 例如:httpRedirectHttps::enable
  • ZStack Cloud支持重定向目的监听端口,SystemTags增加redirectPort选项。
    • 选项格式为:redirectPort::{%s},其中%s可以为1-65535
    • 例如:redirectPort::80
  • ZStack Cloud支持重定向状态码,SystemTags增加statusCode选项。
    • 选项格式为:statusCode::{%s},其中%s可以为301/302/303/307/308
    • 例如:statusCode::302

删除负载均衡监听器(DeleteLoadBalancerListener)

管理员可以使用DeleteLoadBalancerListener删除负载均衡监听器。例如:
DeleteLoadBalancerListener uuid=03b7ad0224774dbab3dcdc4dbce74df4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 负载均衡监听器uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

查询负载均衡监听器(QueryLoadBalancerListener)

管理员可以使用QueryLoadBalancerListener查询负载均衡监听器。例如:
QueryLoadBalancerListener uuid=7e331a2f61ed4c65b96d521115bc9f16
QueryLoadBalancerListener loadBalancer.uuid=bad56001c1f24cefa085fa9cf83f6424

原生域查询(Primitive Fields of Query)

请参见 LoadBalancerListener inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
loadBalancer loadBalancer inventory 0.6
vmNic vm nic inventory 0.6
vmNicRefs vmNicRefs inventory 0.6

更新负载均衡监听器(UpdateLoadBalancerListener)

管理员可以使用UpdateLoadBalancerListener更新负载均衡监听器。例如:
UpdateLoadBalancerListener  uuid=897b8f83e7b44fc785023ae8b8338edd

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 0.6
name 资源名称 0.6
description 资源的详细描述 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

修改负载均衡监听器参数(ChangeLoadBalancerListener)

用户可以使用ChangeLoadBalancerListener修改负载均衡监听器参数。 例如:
ChangeLoadBalancerListener uuid=dc0ee73ed875423a81234fc091e3ce70

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.4.0
connectionIdleTimeout 3.4.0
maxConnection 3.4.0
balancerAlgorithm
  • roundrobin
  • leastconn
  • source
3.4.0
healthCheckTarget 3.4.0
healthyThreshold 3.4.0
unhealthyThreshold 3.4.0
healthCheckInterval 3.4.0
healthCheckProtocol 负载均衡健康检查协议
  • tcp
  • udp
  • http
3.9.0
healthCheckMethod 健康检查方法
  • GET
  • HEAD
3.9.0
healthCheckURI 健康检查的URI 3.9.0
healthCheckHttpCode 健康检查期望的成功返回码 3.9.0
aclStatus 访问控制状态
  • enable
  • disable
3.9.0
securityPolicyType TLS安全策略
  • tls_cipher_policy_default
  • tls_cipher_policy_1_0
  • tls_cipher_policy_1_1
  • tls_cipher_policy_1_2
  • tls_cipher_policy_1_2_strict
  • tls_cipher_policy_1_2_strict_with_1_3
4.1.0
nbprocess 负载均衡进程数量 4.1.0
httpMode 负载均衡HTTP模式
  • http-keep-alive
  • http-server-close
  • http-tunnel
  • httpclose
  • forceclose
4.1.0
sessionPersistence 会话保持模式
  • disable
  • iphash
  • insert
  • rewrite
4.6.0
sessionIdleTimeout 会话保持超时时间 4.6.0
cookieName Cookie名称 4.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
timeout
httpRedirectHttps http重定向https
  • disable
  • enable
4.7.21
redirectPort 重定向端口 4.7.21
statusCode 重定向状态码
  • 301
  • 302
  • 303
  • 307
  • 308
4.7.21
Note:
  • ZStack Cloud修改负载均衡监听器参数时支持设置后端server的权重,SystemTags增加balancerWeight选项。
    • 选项格式为:balancerWeight::{nicUuid}::{weight} ,其中weight为对应后端server的权重.范围:0~100的整数,默认为100。
    • 例如:balancerWeight::{"c44007641c9040c6b2587e19b1b3e2b0"}::{100}

获取云主机网卡(GetCandidateVmNicsForLoadBalancer)

管理员可以使用GetCandidateVmNicsForLoadBalancer获取云主机网卡。例如:
GetCandidateVmNicsForLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
listenerUuid 负载均衡监听器的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

添加云主机网卡到负载均衡器(AddVmNicToLoadBalancer)

管理员可以使用AddVmNicToLoadBalancer添加云主机网卡到负载均衡器。例如:
AddVmNicToLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16 \
vmNicUuids=93dea4f116654754ac4d40e50b3c8cad

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
vmNicUuids 云主机网卡uuid 0.6
listenerUuid 负载均衡监听器的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout
Note:
  • ZStack Cloud添加云主机网卡到负载均衡器时支持设置后端server的权重,SystemTags增加balancerWeight选项。
    • 选项格式为:balancerWeight::{nicUuid}::{weight} ,其中weight为对应后端server的权重.范围:0~100的整数,默认为100。
    • 例如:balancerWeight::{"c44007641c9040c6b2587e19b1b3e2b0"}::{100}

移除云主机网卡(RemoveVmNicFromLoadBalancer)

管理员可以使用RemoveVmNicFromLoadBalancer从负载均衡器移除云主机网卡。例如:
RemoveVmNicFromLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16 \
vmNicUuids=93dea4f116654754ac4d40e50b3c8cad

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
vmNicUuids 云主机网卡uuid 0.6
listenerUuid 负载均衡监听器的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

创建证书(CreateCertificate)

管理员可以使用CreateCertificate创建证书。例如:
CreateCertificate name=www.domain.com certificate=MIIDlzCCAn+gAwIBAgIJAPdiQszRKI/MMA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNVBAYTAkNOMQ8wDQYDVQQIDAZaU1RBQ0sxCzAJBgNVBAcMAlNIMQ0wCwYDVQQKDARaU1kIMQwwCgYDVQQLDANkZXYxGDAWBgNVBAMMD2Rldi56c3Rhawhjay5pbzAeFw0xODAzMjkxMjQ5NDVaFw0xOTAzMjkxMjQ5NDVaMGIxCzAJBgNVBAYTAkNOMQ8wDQYDVQQIDAZaU1RBQ0sxCzAJBgNVBAcMAlNIMQ0wCwYDVQQKDARaU1kIMQwwCgYDVQQLDANkZXYxGDAWBgNVBAMMD2Rldi56c3Rhawhjay5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANc3Q15Wq9IHJyUtMuB+G17WLp3AoVoJTEHbD2xO2RQ0sp+eaOVD3Kj8TkPw+t4ZXIllcMbsJk4+DQP1ix3gnGvlAqThxS6mA3RsUQooHwvYBI8ETePJmurDmz7HEll6XTGHxj7Hp57BnLGQgoJmGqfA8zmtK1Le/zJK6xjpl6GYpfov2h5dU+h9qzv9IBNViUIeW3yn6VY47smtaPCQ5pJT35A7GyqFoTbAlpXca+XS2LTUnNZBgXEmG/d8JBdvvJDSZSQVtVslK0Wx2IsroqkMgyX1EFxjZrIlnQsGb1bEYURgM4oF2deveFjpCUZgI6MOOA6ZuVh1rJxk9XxoZ+0CAwEAAaNQME4wHQYDVR0OBBYEFCLaAR9gaKBopzVqzBu3pUrKm027MB8GA1UdIwQYMBaAFCLaAR9gaKBopzVqzBu3pUrKm027MAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAAuGNv9qZud6UEDfypuHUkGHzECKltEv+S/CgZPXcs1W8zumQjXE7IpFffrAsM9wf51R8dBLaIdnAn6YMuANdrH5L/lALzhrfOwuT6hvEDWznrN7Ea7XANICBactyEpXFxg6eTuFNgWb41IXFJmD225jN82OcFVSQO5/zFfqvnAB6Rz47HV4qKJxs0ZuuAvnbAUf0++pqhxFfjD0TeLPGCB5gNdipprPRJCBiTMFKUN+IJPjjRWcSy1FH8rAZhzNUYtDtwFX4dVoS+CKPaIEurUMCxPzFlgy3VLQU99Mhnn3lxDt9N4OOFCVpLyohfkXLmU5mJGPbs/HT3gl2k+mjt8\u003d

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 0.6
description 资源描述 0.6
certificate 证书 2.3
resourceUuid 资源Uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

更新证书(UpdateCertificate)

管理员可以使用UpdateCertificate更新证书信息。例如:
UpdateCertificate uuid=98c7a9b92e9c4015a66dd930f82337b8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 0.6
name 资源名称 0.6
description 资源描述 0.6
resourceUuid 资源Uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

删除证书(DeleteCertificate)

管理员可以使用DeleteCertificate删除证书。例如:
DeleteCertificate uuid=b7f97d1fb45f4c8785e1b607f671651b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 0.6
deleteMode 0.6
resourceUuid 资源Uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

查询证书(QueryCertificate)

管理员可以使用QueryCertificate查询证书。例如:
QueryCertificate uuid=98c7a9b92e9c4015a66dd930f82337b8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 0.6
name 资源名称 0.6
createDate 创建日期 0.6
lastOpDate 上次操作日期 0.6
groupBy 0.6
description 资源描述 0.6
resourceUuid 资源Uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

添加证书到负载均衡监听器(AddCertificateToLoadBalancerListener)

管理员可以使用AddCertificateToLoadBalancerListener添加证书到负载均衡监听器。例如:
AddCertificateToLoadBalancerListener listenerUuid=a0c2wva8b45f4c8785e1b607f6716013 certificateUuid=b7f97d1fb45f4c8785e1b607f671651b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
certificateUuid 2.3
listenerUuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

移除证书(RemoveCertificateFromLoadBalancerListener)

管理员可以使用RemoveCertificateFromLoadBalancerListener从负载均衡移除证书。例如:
RemoveCertificateFromLoadBalancerListener listenerUuid=a0c2wva8b45f4c8785e1b607f6716013 certificateUuid=98c7a9b92e9c4015a66dd930f82337b8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
certificateUuid 2.3
listenerUuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 LoadBalancerListenerVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 LoadBalancerListenerVO 0.6
timeout

添加转发规则到访问控制策略组(AddAccessControlListRedirectRule)

用户可以使用AddAccessControlListRedirectRule添加转发规则到访问控制策略组。 例如:
AddAccessControlListRedirectRule aclUuid=bad56001c1f24cefa085fa9cf83f6424

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 4.1.0
description 资源的详细描述 4.1.0
domain 域名 4.1.0
url url 4.1.0
aclUuid 访问控制策略组的唯一标识 4.1.0
resourceUuid 资源UUID 4.1.0
tagUuids 标签UUID列表 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.1.0
timeout

修改控制策略组转发规则名称(ChangeAccessControlListRedirectRule)

用户可以使用ChangeAccessControlListRedirectRule修改控制策略组转发规则名称。 例如:
ChangeAccessControlListRedirectRule uuid=bad56001c1fac4512a9cf83f6424

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.1.0
name 转发规则名称 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.1.0
timeout

修改访问控制组绑定的后端服务器组(ChangeAccessControlListServerGroup)

用户可以使用ChangeAccessControlListServerGroup修改访问控制组绑定的后端服务器组。 例如:
ChangeAccessControlListServerGroup serverGroupUuids=bad56001c1fac4512a9cf83f6424 listenerUuid=89bdb613cad93f5f881b9127986d4d1b aclUuid=e58cd2cd6a633f999909c7e5ce448e07

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuids 负载均衡器服务器组uuid 4.1.0
listenerUuid 监听器唯一标识 4.1.0
aclUuid 访问控制策略组的唯一标识 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.1.0
timeout

获取负载均衡监听器访问控制策略条目(GetLoadBalancerListenerACLEntries)

用户可以使用GetLoadBalancerListenerACLEntries获取负载均衡监听器访问控制策略条目。 例如:
GetLoadBalancerListenerACLEntries listenerUuids=e58cd2cd6a633f999909c7e5ce448e07

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
listenerUuids 4.1.0
type 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.1.0
timeout

创建访问控制策略组(CreateAccessControlList)

用户可以使用CreateAccessControlList创建访问控制策略组。 例如:
CreateAccessControlList name=acl-group ipVersion=4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.9.0
description 资源的详细描述 3.9.0
ipVersion IP协议版本
  • 4
  • 6
3.9.0
resourceUuid 资源UUID 3.9.0
tagUuids 标签UUID列表 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

删除访问控制策略组(DeleteAccessControlList)

用户可以使用DeleteAccessControlList删除访问控制策略组。 例如:
DeleteAccessControlList uuid=f2a128d702d83f4389ad82d425b0e74e deleteMode=Permissive

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.9.0
deleteMode 删除模式(Permissive / Enforcing,Permissive) 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

查询访问控制策略组(QueryAccessControlList)

管理员可以使用QueryAccessControlList查询访问控制策略组。例如:
QueryAccessControlList uuid=0abdbd20b8173ccf89f881309b5e40d0

原生域查询(Primitive Fields of Query)

请参见访问控制策略组清单(AccessControlList Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
loadBalancerListener 负载均衡监听器清单(LoadBalancerListener Inventory) 访问控制策略组相关负载均衡监听器 3.9.0

删除访问控制策略的IP组(RemoveAccessControlListEntry)

用户可以使用RemoveAccessControlListEntry删除访问控制策略的IP组。 例如:
RemoveAccessControlListEntry aclUuid=c151f0f90e143c26b6667e70ebbe5b7b uuid=22c9d1f964b63f6abc52fed8437042a3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
aclUuid 访问控制策略组的唯一标识 3.9.0
uuid 资源的UUID,唯一标示该资源 3.9.0
deleteMode 删除模式(Permissive / Enforcing,Permissive) 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

向访问控制策略组添加IP组(AddAccessControlListEntry)

用户可以使用AddAccessControlListEntry向访问控制策略组添加IP组。 例如:
AddAccessControlListEntry aclUuid=101a39fcb6c538a4914d0ae7fa8468a4 entries=192.168.12.1,192.168.48.0/24

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
aclUuid 访问控制策略组的唯一标识 3.9.0
entries IP组 3.9.0
description 资源的详细描述 3.9.0
resourceUuid 资源UUID 3.9.0
tagUuids 标签UUID列表 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

添加监听器的访问控制策略(AddAccessControlListToLoadBalancer)

用户可以使用AddAccessControlListToLoadBalancer添加监听器的访问控制策略。 例如:
AddAccessControlListToLoadBalancer aclUuids=25e10ecdb6d63b598899c1103d2cdf46 aclType=white listenerUuid=19c1a4dcaea637da86e3ecbb6a3a5f6e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
aclUuids 访问控制策略组的唯一标识 3.9.0
aclType 访问控制策略类型
  • white
  • black
  • redirect
4.1.0
listenerUuid 监听器唯一标识 3.9.0
serverGroupUuids 负载均衡器服务器组uuid 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

删除监听器访问控制策略(RemoveAccessControlListFromLoadBalancer)

用户可以使用RemoveAccessControlListFromLoadBalancer删除监听器访问控制策略。 例如:
RemoveAccessControlListFromLoadBalancer aclUuids=027bfcc0fddf39e3be51badf4777c0cd listenerUuid=0299b3e26af5350c8db91930723d2065

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
aclUuids 访问控制策略组唯一标识 3.9.0
listenerUuid 监听器唯一标识 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

获取监听器可加载L3网络(GetCandidateL3NetworksForLoadBalancer)

用户可以使用GetCandidateL3NetworksForLoadBalancer获取监听器可加载L3网络。 例如:
GetCandidateL3NetworksForLoadBalancer listenerUuid=6ecc19bdec0139499e3abf6c51bca683

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
listenerUuid 3.9.0
limit 3.9.0
start 3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

创建负载均衡器服务器组(CreateLoadBalancerServerGroup)

用户可以使用CreateLoadBalancerServerGroup创建负载均衡器服务器组。 例如:
CreateLoadBalancerServerGroup name=BackendServerGroup loadBalancerUuid=70320d7aaedf4241a426560d09d99863

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 4.0.0
description 资源的详细描述 4.0.0
loadBalancerUuid 负载均衡器UUID 4.0.0
resourceUuid 资源UUID 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

删除负载均衡器服务器组(DeleteLoadBalancerServerGroup)

用户可以使用DeleteLoadBalancerServerGroup删除负载均衡器服务器组。 例如:
DeleteLoadBalancerServerGroup uuid=70320d7aaedf4241a426560d09d99863

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 服务器组uuid 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

更新负载均衡器服务器组(UpdateLoadBalancerServerGroup)

用户可以使用pdateLoadBalancerServerGroup更新负载均衡器服务器组。 例如:
UpdateLoadBalancerServerGroup uuid=bad56001c1f24cefa085fa9cf83f6424

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.0.0
name 资源名称 4.0.0
description 资源的详细描述 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

查询负载均衡器服务器组(QueryLoadBalancerServerGroup)

管理员可以使用QueryLoadBalancerServerGroup查询负载均衡器服务器组。 例如:
QueryLoadBalancerServerGroup uuid=70320d7aaedf4241a426560d09d99863

原生域查询(Primitive Fields of Query)

请参见负载均衡器服务器组清单(LoadBalancerServerGroup Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
listenerServerGroupRefs listenerServerGroupRefs 清单(listenerServerGroupRefs inventory) 负载均衡监听器 4.0.0

添加后端服务器到服务器组(AddBackendServerToServerGroup)

用户可以使用AddBackendServerToServerGroup添加后端服务器到服务器组。 例如:
AddBackendServerToServerGroup serverGroupUuid=70320d7aaedf4241a426560d09d99863

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 负载均衡器服务器组uuid 4.0.0
vmNics 后端服务器网卡 4.0.0
servers 后端服务器Ip 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

从服务器组移除后端服务器(RemoveBackendServerFromServerGroup)

用户可以使用RemoveBackendServerFromServerGroup从服务器组移除后端服务器。 例如:
RemoveBackendServerFromServerGroup serverGroupUuid=70320d7aaedf4241a426560d09d99863

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 负载均衡器服务器组uuid 4.0.0
vmNics 4.0.0
serverIps 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

添加服务器组到负载均衡监听器(AddServerGroupToLoadBalancerListener)

用户可以使用AddServerGroupToLoadBalancerListener将负载均衡器服务器组添加到监听器。 例如:
AddServerGroupToLoadBalancerListener serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16 listenerUuid=93dea4f116654754ac4d40e50b3c8cad

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 负载均衡器服务器组uuid 4.0.0
listenerUuid 负载均衡器监听器uuid 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

从负载均衡监听器移除服务器组(RemoveServerGroupFromLoadBalancerListener)

用户可以使用RemoveServerGroupFromLoadBalancerListener从负载均衡监听器移除服务器组。 例如:
RemoveServerGroupFromLoadBalancerListener serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16 listenerUuid=93dea4f116654754ac4d40e50b3c8cad

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 服务器组uuid 4.0.0
listenerUuid 监听器uuid 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

更新负载均衡后端服务器参数(ChangeLoadBalancerBackendServer)

用户可以使用ChangeLoadBalancerBackendServer修改负载均衡后端服务器参数。 例如:
ChangeLoadBalancerBackendServer serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 负载均衡器服务器组uuid 4.0.0
vmNics 后端服务器组网卡 4.0.0
servers 后端服务器组网ip 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

获取可供负载均衡器服务器组添加的云主机网卡(GetCandidateVmNicsForLoadBalancerServerGroup)

用户可以使用GetCandidateVmNicsForLoadBalancerServerGroup获取可供负载均衡器服务器组添加的云主机网卡。 例如:
GetCandidateVmNicsForLoadBalancerServerGroup serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
serverGroupUuid 负载均衡器服务器组uuid 4.0.0
loadBalancerUuid 负载均衡器uuid 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

创建性能独享型负载均衡器组(CreateSlbGroup)

用户可以使用CreateSlbGroup创建性能独享型负载均衡器组。 例如:
CreateSlbGroup name=SLBGroup slbOfferingUuid=bad56001c1f24cefa085fa9cf83f6424 frontEndL3NetworkUuid=dc0ee73ed875423aa6778fc091e3ce70

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 4.0.0
slbOfferingUuid 高性能实例规格uuid 4.0.0
frontEndL3NetworkUuid 前端网络uuid 4.0.0
backendL3NetworkUuids 后端所属网络uuid 4.0.0
backendType 后端类型
  • VYOS
4.0.0
deployType 部署类型
  • Direct
4.0.0
description 资源的详细描述 4.0.0
resourceUuid 资源UUID 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

删除性能独享型负载均衡器组(DeleteSlbGroup)

用户可以使用DeleteSlbGroup删除性能独享型负载均衡器组。 例如:
DeleteSlbGroup uuid=70320d7aaedf4241a426560d09d99863

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.0.0
deleteMode 删除模式
  • Permissive
  • Enforcing
4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

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

管理员可以使用UpdateSlbGroup更新性能独享型负载均衡器组。例如:
UpdateSlbGroup uuid=897b8f83e7b44fc785023ae8b8338edd

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 4.0.0
name 资源名称 4.0.0
description 资源的详细描述 4.0.0
slbOfferingUuid 性能独享型负载均衡器规格 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

查询性能独享型负载均衡器组(QuerySlbGroup)

管理员可以使用QuerySlbGroup查询性能独享型负载均衡器组。例如:
QuerySlbGroup uuid=7e331a2f61ed4c65b96d521115bc9f16

原生域查询(Primitive Fields of Query)

请参见 SlbGroup inventory

创建高性能实例性负载均衡器规格(CreateSlbOffering)

用户可以使用CreateSlbOffering创建高性能负载均衡器实例规格。 例如:
CreateSlbOffering name=SLBOffering zoneUuid=bad56001c1f24cefa085fa9cf83f6424 managementNetworkUuid=dc0ee73ed875423aa6778fc091e3ce70 imageUuid=2aa6ae40c4954143be0ecb9a6a160b5b cpuNum=1 memorySize=1073741824

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
zoneUuid 区域UUID 4.0.0
managementNetworkUuid 管理网络UUID 4.0.0
imageUuid 镜像UUID 4.0.0
name 资源名称 4.0.0
description 资源的详细描述 4.0.0
cpuNum 4.0.0
memorySize 4.0.0
allocatorStrategy 4.0.0
sortKey 4.0.0
type 4.0.0
resourceUuid 资源UUID 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout

查询性能独享型负载均衡器规格(QuerySlbOffering)

管理员可以使用QuerySlbOffering查询性能独享型负载均衡器规格。例如:
QuerySlbOffering uuid=7e331a2f61ed4c65b96d521115bc9f16

原生域查询(Primitive Fields of Query)

请参见 QuerySlbOffering inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
image image inventory 4.0.0
managementL3Network L3 network inventory 4.0.0
publicL3Network L3 network inventory 4.0.0
vmInstance VM instance inventory 4.0.0
zone zone inventory 4.0.0

创建高性能负载均衡器实例(CreateSlbInstance)

用户可以使用CreateSlbInstance创建高性能负载均衡器实例。 例如:
CreateSlbInstance name=SLBinstance slbGroupUuid=bad56001c1f24cefa085fa9cf83f6424

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 4.0.0
slbGroupUuid 性能独享型负载均衡器组UUID 4.0.0
description 资源的详细描述 4.0.0
zoneUuid 区域UUID 4.0.0
clusterUuid 集群UUID 4.0.0
hostUuid 物理机UUID 4.0.0
resourceUuid 资源UUID 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.0.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.0.0
timeout
CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心