public class HealthChecker extends AbstractModel
header, skipSign
Constructor and Description |
---|
HealthChecker() |
HealthChecker(HealthChecker source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
Long |
getCriticalThreshold()
Get 不健康阈值,表示连续几次健康检查结果为"不健康",则判断源站为"不健康",单位为次,默认 2 次。
|
String[] |
getExpectedCodes()
Get 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测节点向源站发起健康检查时,响应哪些状态码可用于认定探测结果为健康。
|
String |
getFollowRedirect()
Get 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示是否启用遵循 301/302 重定向。启用后,301/302 默认为"健康"的状态码,默认跳转 3 次。
|
CustomizedHeader[] |
getHeaders()
Get 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测请求携带的自定义 HTTP 请求头,至多可配置 10 个。
|
Long |
getHealthThreshold()
Get 健康阈值,表示连续几次健康检查结果为"健康",则判断源站为"健康",单位为次,默认 3 次,最小取值 1 次。
|
Long |
getInterval()
Get 检查频率,表示多久发起一次健康检查任务,单位为秒。可取值有:30,60,180,300 或 600。
|
String |
getMethod()
Get 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示请求方法,取值有:
GET;
HEAD。
|
String |
getPath()
Get 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测路径,需要填写完整的 host/path,不包含协议部分,例如:www.example.com/test。
|
Long |
getPort()
Get 检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。
|
String |
getRecvContext()
Get 该参数仅当 Type=UDP 时有效,表示健康检查期望源站返回结果。只允许 ASCII 可见字符,最大长度限制 500 个字符。
|
String |
getSendContext()
Get 该参数仅当 Type=UDP 时有效,表示健康检查发送的内容。只允许 ASCII 可见字符,最大长度限制 500 个字符。
|
Long |
getTimeout()
Get 每一次健康检查的超时时间,若健康检查消耗时间大于此值,则检查结果判定为”不健康“, 单位为秒,默认值为 5s,取值必须小于 Interval。
|
String |
getType()
Get 健康检查策略,取值有:
HTTP;
HTTPS;
TCP;
UDP;
ICMP Ping;
NoCheck。
注意:NoCheck 表示不启用健康检查策略。
|
void |
setCriticalThreshold(Long CriticalThreshold)
Set 不健康阈值,表示连续几次健康检查结果为"不健康",则判断源站为"不健康",单位为次,默认 2 次。
|
void |
setExpectedCodes(String[] ExpectedCodes)
Set 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测节点向源站发起健康检查时,响应哪些状态码可用于认定探测结果为健康。
|
void |
setFollowRedirect(String FollowRedirect)
Set 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示是否启用遵循 301/302 重定向。启用后,301/302 默认为"健康"的状态码,默认跳转 3 次。
|
void |
setHeaders(CustomizedHeader[] Headers)
Set 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测请求携带的自定义 HTTP 请求头,至多可配置 10 个。
|
void |
setHealthThreshold(Long HealthThreshold)
Set 健康阈值,表示连续几次健康检查结果为"健康",则判断源站为"健康",单位为次,默认 3 次,最小取值 1 次。
|
void |
setInterval(Long Interval)
Set 检查频率,表示多久发起一次健康检查任务,单位为秒。可取值有:30,60,180,300 或 600。
|
void |
setMethod(String Method)
Set 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示请求方法,取值有:
GET;
HEAD。
|
void |
setPath(String Path)
Set 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测路径,需要填写完整的 host/path,不包含协议部分,例如:www.example.com/test。
|
void |
setPort(Long Port)
Set 检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。
|
void |
setRecvContext(String RecvContext)
Set 该参数仅当 Type=UDP 时有效,表示健康检查期望源站返回结果。只允许 ASCII 可见字符,最大长度限制 500 个字符。
|
void |
setSendContext(String SendContext)
Set 该参数仅当 Type=UDP 时有效,表示健康检查发送的内容。只允许 ASCII 可见字符,最大长度限制 500 个字符。
|
void |
setTimeout(Long Timeout)
Set 每一次健康检查的超时时间,若健康检查消耗时间大于此值,则检查结果判定为”不健康“, 单位为秒,默认值为 5s,取值必须小于 Interval。
|
void |
setType(String Type)
Set 健康检查策略,取值有:
HTTP;
HTTPS;
TCP;
UDP;
ICMP Ping;
NoCheck。
注意:NoCheck 表示不启用健康检查策略。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public HealthChecker()
public HealthChecker(HealthChecker source)
public String getType()
public void setType(String Type)
Type
- 健康检查策略,取值有:
public Long getPort()
public void setPort(Long Port)
Port
- 检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。public Long getInterval()
public void setInterval(Long Interval)
Interval
- 检查频率,表示多久发起一次健康检查任务,单位为秒。可取值有:30,60,180,300 或 600。public Long getTimeout()
public void setTimeout(Long Timeout)
Timeout
- 每一次健康检查的超时时间,若健康检查消耗时间大于此值,则检查结果判定为”不健康“, 单位为秒,默认值为 5s,取值必须小于 Interval。public Long getHealthThreshold()
public void setHealthThreshold(Long HealthThreshold)
HealthThreshold
- 健康阈值,表示连续几次健康检查结果为"健康",则判断源站为"健康",单位为次,默认 3 次,最小取值 1 次。public Long getCriticalThreshold()
public void setCriticalThreshold(Long CriticalThreshold)
CriticalThreshold
- 不健康阈值,表示连续几次健康检查结果为"不健康",则判断源站为"不健康",单位为次,默认 2 次。public String getPath()
public void setPath(String Path)
Path
- 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测路径,需要填写完整的 host/path,不包含协议部分,例如:www.example.com/test。public String getMethod()
public void setMethod(String Method)
Method
- 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示请求方法,取值有:
public String[] getExpectedCodes()
public void setExpectedCodes(String[] ExpectedCodes)
ExpectedCodes
- 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测节点向源站发起健康检查时,响应哪些状态码可用于认定探测结果为健康。public CustomizedHeader[] getHeaders()
public void setHeaders(CustomizedHeader[] Headers)
Headers
- 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测请求携带的自定义 HTTP 请求头,至多可配置 10 个。public String getFollowRedirect()
public void setFollowRedirect(String FollowRedirect)
FollowRedirect
- 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示是否启用遵循 301/302 重定向。启用后,301/302 默认为"健康"的状态码,默认跳转 3 次。public String getSendContext()
public void setSendContext(String SendContext)
SendContext
- 该参数仅当 Type=UDP 时有效,表示健康检查发送的内容。只允许 ASCII 可见字符,最大长度限制 500 个字符。public String getRecvContext()
public void setRecvContext(String RecvContext)
RecvContext
- 该参数仅当 Type=UDP 时有效,表示健康检查期望源站返回结果。只允许 ASCII 可见字符,最大长度限制 500 个字符。Copyright © 2025. All rights reserved.