public class HealthCheck extends AbstractModel
Constructor and Description |
---|
HealthCheck() |
HealthCheck(HealthCheck 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 |
getCheckPort()
Get 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getCheckType()
Get 自定义探测相关参数。健康检查使用的协议:TCP | HTTP | CUSTOM(仅适用于TCP/UDP监听器,其中UDP监听器只支持CUSTOM;如果使用自定义健康检查功能,则必传)。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getContextType()
Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。(仅适用于TCP/UDP监听器)
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getHealthNum()
Get 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getHealthSwitch()
Get 是否开启健康检查:1(开启)、0(关闭)。
|
String |
getHttpCheckDomain()
Get 健康检查域名(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getHttpCheckMethod()
Get 健康检查方法(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式),默认值:HEAD,可选值HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getHttpCheckPath()
Get 健康检查路径(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getHttpCode()
Get 健康检查状态码(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 代表健康,2 表示返回 2xx 代表健康,4 表示返回 3xx 代表健康,8 表示返回 4xx 代表健康,16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康,则将相应的值相加。注意:TCP监听器的HTTP健康检查方式,只支持指定一种健康检查状态码。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getHttpVersion()
Get 自定义探测相关参数。健康检查协议CheckType的值取HTTP时,必传此字段,代表后端服务的HTTP版本:HTTP/1.0、HTTP/1.1;(仅适用于TCP监听器)
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getIntervalTime()
Get 健康检查探测间隔时间,默认值:5,可选值:5~300,单位:秒。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getRecvContext()
Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getSendContext()
Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getTimeOut()
Get 健康检查的响应超时时间(仅适用于四层监听器),可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getUnHealthNum()
Get 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setCheckPort(Long CheckPort)
Set 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setCheckType(String CheckType)
Set 自定义探测相关参数。健康检查使用的协议:TCP | HTTP | CUSTOM(仅适用于TCP/UDP监听器,其中UDP监听器只支持CUSTOM;如果使用自定义健康检查功能,则必传)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setContextType(String ContextType)
Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。(仅适用于TCP/UDP监听器)
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHealthNum(Long HealthNum)
Set 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHealthSwitch(Long HealthSwitch)
Set 是否开启健康检查:1(开启)、0(关闭)。
|
void |
setHttpCheckDomain(String HttpCheckDomain)
Set 健康检查域名(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHttpCheckMethod(String HttpCheckMethod)
Set 健康检查方法(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式),默认值:HEAD,可选值HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHttpCheckPath(String HttpCheckPath)
Set 健康检查路径(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHttpCode(Long HttpCode)
Set 健康检查状态码(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 代表健康,2 表示返回 2xx 代表健康,4 表示返回 3xx 代表健康,8 表示返回 4xx 代表健康,16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康,则将相应的值相加。注意:TCP监听器的HTTP健康检查方式,只支持指定一种健康检查状态码。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setHttpVersion(String HttpVersion)
Set 自定义探测相关参数。健康检查协议CheckType的值取HTTP时,必传此字段,代表后端服务的HTTP版本:HTTP/1.0、HTTP/1.1;(仅适用于TCP监听器)
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setIntervalTime(Long IntervalTime)
Set 健康检查探测间隔时间,默认值:5,可选值:5~300,单位:秒。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setRecvContext(String RecvContext)
Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setSendContext(String SendContext)
Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setTimeOut(Long TimeOut)
Set 健康检查的响应超时时间(仅适用于四层监听器),可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setUnHealthNum(Long UnHealthNum)
Set 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public HealthCheck()
public HealthCheck(HealthCheck source)
public Long getHealthSwitch()
public void setHealthSwitch(Long HealthSwitch)
HealthSwitch
- 是否开启健康检查:1(开启)、0(关闭)。public Long getTimeOut()
public void setTimeOut(Long TimeOut)
TimeOut
- 健康检查的响应超时时间(仅适用于四层监听器),可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
注意:此字段可能返回 null,表示取不到有效值。public Long getIntervalTime()
public void setIntervalTime(Long IntervalTime)
IntervalTime
- 健康检查探测间隔时间,默认值:5,可选值:5~300,单位:秒。
注意:此字段可能返回 null,表示取不到有效值。public Long getHealthNum()
public void setHealthNum(Long HealthNum)
HealthNum
- 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。public Long getUnHealthNum()
public void setUnHealthNum(Long UnHealthNum)
UnHealthNum
- 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。public Long getHttpCode()
public void setHttpCode(Long HttpCode)
HttpCode
- 健康检查状态码(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 代表健康,2 表示返回 2xx 代表健康,4 表示返回 3xx 代表健康,8 表示返回 4xx 代表健康,16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康,则将相应的值相加。注意:TCP监听器的HTTP健康检查方式,只支持指定一种健康检查状态码。
注意:此字段可能返回 null,表示取不到有效值。public String getHttpCheckPath()
public void setHttpCheckPath(String HttpCheckPath)
HttpCheckPath
- 健康检查路径(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。public String getHttpCheckDomain()
public void setHttpCheckDomain(String HttpCheckDomain)
HttpCheckDomain
- 健康检查域名(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。public String getHttpCheckMethod()
public void setHttpCheckMethod(String HttpCheckMethod)
HttpCheckMethod
- 健康检查方法(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式),默认值:HEAD,可选值HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。public Long getCheckPort()
public void setCheckPort(Long CheckPort)
CheckPort
- 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。public String getContextType()
public void setContextType(String ContextType)
ContextType
- 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。(仅适用于TCP/UDP监听器)
注意:此字段可能返回 null,表示取不到有效值。public String getSendContext()
public void setSendContext(String SendContext)
SendContext
- 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。public String getRecvContext()
public void setRecvContext(String RecvContext)
RecvContext
- 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。public String getCheckType()
public void setCheckType(String CheckType)
CheckType
- 自定义探测相关参数。健康检查使用的协议:TCP | HTTP | CUSTOM(仅适用于TCP/UDP监听器,其中UDP监听器只支持CUSTOM;如果使用自定义健康检查功能,则必传)。
注意:此字段可能返回 null,表示取不到有效值。public String getHttpVersion()
public void setHttpVersion(String HttpVersion)
HttpVersion
- 自定义探测相关参数。健康检查协议CheckType的值取HTTP时,必传此字段,代表后端服务的HTTP版本:HTTP/1.0、HTTP/1.1;(仅适用于TCP监听器)
注意:此字段可能返回 null,表示取不到有效值。Copyright © 2021. All rights reserved.