附录

Model对象定义

BLBModel

参数名称 类型 描述
blbId String LoadBalancer的标识符
name String LoadBalancer的名称
desc String LoadBalancer的描述
address String 分配的内网服务地址IP,通过这个IP即能通过内网访问该实例
status blbStatus BLB状态
vpcId String vpc 的ID
publicIp String 如果LoadBalancer绑定过EIP,则显示该项,否则不显示
tags List<TagModel> 标签键值对列表

TCPListenerModel

参数名称 类型 描述
listenerPort int 监听器的监听端口
backendPort int 后端服务器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash"
healthCheckTimeoutInSecond int 健康检查超时
healthCheckInterval int 健康检查间隔
unhealthyThreshold int 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器
healthyThreshold int 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用

UDPListenerModel

参数名称 类型 描述
listenerPort int 监听器的监听端口
backendPort int 后端服务器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash"
healthCheckTimeoutInSecond int 健康检查超时
healthCheckInterval int 健康检查间隔
unhealthyThreshold int 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器
healthyThreshold int 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用
healthCheckString String 健康发送的请求字符串,后端服务器收到后需要进行应答,支持标准转义如\00、\xf2,方便配置二进制格式请求

HTTPListenerModel

参数名称 类型 描述
listenerPort int 监听器的监听端口
backendPort int 后端服务器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"
keepSession bool 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器
keepSessionType String 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite"
keepSessionDuration int 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效
keepSessionCookieName int 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
xForwardFor bool 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址
healthCheckType String 健康检查协议,值为"HTTP"/"TCP"
healthCheckPort int 健康检查端口
healthCheckURI String 健康检查URI
healthCheckTimeoutInSecond int 健康检查超时
healthCheckInterval int 健康检查间隔
unhealthyThreshold int 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器
healthyThreshold int 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用
healthCheckNormalStatus String 健康检查正常时的HTTP状态码,支持5类状态码的组合,格式为http_1xx或http_2xx
serverTimeout int 后端服务器最大超时(单位:秒)
redirectPort int 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定

HTTPSListenerModel

参数名称 类型 描述
listenerPort int 监听器的监听端口
backendPort int 后端服务器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"
keepSession bool 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器
keepSessionType String 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite"
keepSessionDuration int 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效
keepSessionCookieName int 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
xForwardFor bool 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址
healthCheckType String 健康检查协议,值为"HTTP"/"TCP"
healthCheckPort int 健康检查端口
healthCheckURI String 健康检查URI
healthCheckTimeoutInSecond int 健康检查超时
healthCheckInterval int 健康检查间隔
unhealthyThreshold int 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器
healthyThreshold int 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用
healthCheckNormalStatus String 健康检查正常时的HTTP状态码,支持5类状态码的组合,格式为http_1xx 或 http_2xx
serverTimeout int 后端服务器最大超时(单位:秒)
certIds List<String> 加载的SSl证书,目前HTTPS监听器只能绑定一个SSL证书
ie6Compatible bool 是否开启IE6兼容较早的SSL3.0

BackendServerModel

参数名称 类型 描述
instanceId String 后端服务器标识符
weight int 后端服务器权重,取值范围[0, 100],权重为0表示不要把流量转发到该后端服务器上

BackendServerStatus

参数名称 类型 描述
instanceId String 后端服务器标识符
weight int 后端服务器权重
status String 后端服务器健康状态,值为"Alive"/"Dead"/"Unknown"

AppBLBModel

参数名称 类型 描述
blbId String LoadBalancer的标识符
name String LoadBalancer的名称
desc String LoadBalancer的描述
address String LoadBalancer的地址,点分十进制表示
status blbStatus BLB状态
vpcId String vpc短Id
publicIp String 如果LoadBalancer绑定过EIP,则显示该项,否则不显示
tags List 标签键值对列表

TagModel

参数名称 类型 描述
tagKey String 标签的键,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度1-65
tagValue String 标签的值,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度0-65

ListenerModel

参数名称 类型 描述
port int 监听器端口
type String 监听器协议类型

AppTCPListenerModel

参数名称 类型 描述
port int 监听器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"

AppUDPListenerModel

参数名称 类型 描述
port int 监听器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash"

AppHTTPListenerModel

参数名称 类型 描述
port int 监听器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"
keepSession boolean 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器
keepSessionType String 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite"
keepSessionTimeout int 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效
keepSessionCookieName int 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
xForwardedFor boolean 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址
serverTimeout int 后端服务器最大超时(单位:秒)
redirectPort int 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定

AppHTTPSListenerModel

参数名称 类型 描述
port int 监听器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"
keepSession boolean 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器
keepSessionType String 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite"
keepSessionTimeout int 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效
keepSessionCookieName int 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
xForwardedFor boolean 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址
serverTimeout int 后端服务器最大超时(单位:秒)
certIds List\ 加载的SSl证书链
encryptionType String 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
encryptionProtocols List\ 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
dualAuth boolean 是否开启双向认证,默认为关闭
clientCertIds List\ 当dualAuth为true时,加载的客户端证书链

AppSSLListenerModel

参数名称 类型 描述
port int 监听器的监听端口
scheduler String 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash"
certIds List\ 加载的SSl证书链
encryptionType String 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
encryptionProtocols List\ 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
dualAuth boolean 是否开启双向认证,默认为关闭
clientCertIds List\ 当dualAuth为true时,加载的客户端证书链

AppBackendServer

参数名称 类型 描述
instanceId String 后端服务器标识符
weight int 后端服务器权重,取值范围0-100
privateIp String 查询时返回值,后端绑定的该服务器ip地址
portList List<AppRsPortModel> 查询时返回值,设置了相应策略,RS开放的端口列表

AppRsPortModel

参数名称 类型 描述
listenerPort int 监听器端口
backendPort int 后端开放的端口
portType String 端口协议类型
healthCheckPortType String 健康检查端口协议类型
status String 端口状态,"Alive"/"Dead"/"Unknown"
portId String 端口id
policyId String 对应策略id

AppServerGroup

参数名称 类型 描述
id String 后端服务器组标识符
name String 后端服务器组名称
desc String 后端服务器组描述
status String 服务器组状态,详见blbStatus
portList List<AppServerGroupPort> 服务器组开放的端口列表

AppServerGroupPort

参数名称 类型 描述
id String 服务器组端口标识符
port int 服务器组开放端口号
type String 端口协议类型,"TCP"/"HTTP"
status String 服务器组状态,详见blbStatus
healthCheck String 健康检查协议,支持"HTTP"/"TCP"
healthCheckPort int 健康检查端口
healthCheckTimeoutInSecond int 健康检查超时(单位:秒),默认为3,需为1-60间的整数
healthCheckIntervalInSecond int 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
healthCheckDownRetry int 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
healthCheckUpRetry int 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
healthCheckNormalStatus String 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效
healthCheckUrlPath String 健康检查URI,默认/。当健康检查协议为"HTTP"时生效
udpHealthCheckString String udp健康检查字符串,当端口类型为udp是有效

AppPolicy

参数名称 类型 描述
desc String 策略描述默认为空
appServerGroupId String 策略绑定服务器组标识符
backendPort int 目标端口号,当listenerPort对应监听器为TCP或SSL时需要传入对应服务器组(appServerGroupId)下开放的TCP端口号;当listenerPort对应监听器为HTTP或HTTPS时需要传入对应服务器组(appServerGroupId)下开放的HTTP端口号;当listenerPort对应监听器为UDP时需要传入对应服务器组(appServerGroupId)下开放的UDP端口号
priority int 策略优先级,有效取值范围是1-32768
ruleList List<AppRule> 策略规则列表

AppRule

参数名称 类型 描述
key String 规则的类型,host/uri/*
value String 通配符匹配字符串,详见ValueExample

规则配置示例

ValueExample

key value 描述
* * 全匹配
host *.baidu.com 匹配以“.baidu.com”结尾的域名
uri /abc/def.* 匹配以“/abc/def.”开头的URI路径

状态编码定义

blbStatus

状态 描述
creating 创建中
available 运行中
updating 更新中
paused 已欠费
unavailable 暂不可用