HealthCheck (tencentcloud-sdk-java 3.0.112 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.clb.v20180317.models.HealthCheck

public class HealthCheck
extends AbstractModel

构造器概要

构造器
构造器和说明

HealthCheck()

构造器
构造器和说明
`HealthCheck()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Integer`	`getCheckPort()` 获取自定义探测相关参数。
`String`	`getCheckType()` 获取自定义探测相关参数。
`String`	`getContextType()` 获取自定义探测相关参数。
`Integer`	`getHealthNum()` 获取健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。
`Integer`	`getHealthSwitch()` 获取是否开启健康检查：1（开启）、0（关闭）。
`String`	`getHttpCheckDomain()` 获取健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`String`	`getHttpCheckMethod()` 获取健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。
`String`	`getHttpCheckPath()` 获取健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`Integer`	`getHttpCode()` 获取健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`String`	`getHttpVersion()` 获取自定义探测相关参数。
`Integer`	`getIntervalTime()` 获取健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。
`String`	`getRecvContext()` 获取自定义探测相关参数。
`String`	`getSendContext()` 获取自定义探测相关参数。
`Integer`	`getTimeOut()` 获取健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。
`Integer`	`getUnHealthNum()` 获取不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。
`void`	`setCheckPort(Integer CheckPort)` 设置自定义探测相关参数。
`void`	`setCheckType(String CheckType)` 设置自定义探测相关参数。
`void`	`setContextType(String ContextType)` 设置自定义探测相关参数。
`void`	`setHealthNum(Integer HealthNum)` 设置健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。
`void`	`setHealthSwitch(Integer HealthSwitch)` 设置是否开启健康检查：1（开启）、0（关闭）。
`void`	`setHttpCheckDomain(String HttpCheckDomain)` 设置健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`void`	`setHttpCheckMethod(String HttpCheckMethod)` 设置健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。
`void`	`setHttpCheckPath(String HttpCheckPath)` 设置健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`void`	`setHttpCode(Integer HttpCode)` 设置健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。
`void`	`setHttpVersion(String HttpVersion)` 设置自定义探测相关参数。
`void`	`setIntervalTime(Integer IntervalTime)` 设置健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。
`void`	`setRecvContext(String RecvContext)` 设置自定义探测相关参数。
`void`	`setSendContext(String SendContext)` 设置自定义探测相关参数。
`void`	`setTimeOut(Integer TimeOut)` 设置健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。
`void`	`setUnHealthNum(Integer UnHealthNum)` 设置不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。
`void`	`toMap(HashMap<String,String> map, String prefix)` 内部实现，用户禁止调用

从类继承的方法 com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - HealthCheck
```
public HealthCheck()
```
- 方法详细资料
  - getHealthSwitch
```
public Integer getHealthSwitch()
```
    获取是否开启健康检查：1（开启）、0（关闭）。
    
    返回:
    
    HealthSwitch 是否开启健康检查：1（开启）、0（关闭）。
  - setHealthSwitch
```
public void setHealthSwitch(Integer HealthSwitch)
```
    设置是否开启健康检查：1（开启）、0（关闭）。
    
    参数:
    
    HealthSwitch - 是否开启健康检查：1（开启）、0（关闭）。
  - getTimeOut
```
public Integer getTimeOut()
```
    获取健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    TimeOut 健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
  - setTimeOut
```
public void setTimeOut(Integer TimeOut)
```
    设置健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    TimeOut - 健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
  - getIntervalTime
```
public Integer getIntervalTime()
```
    获取健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    IntervalTime 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
  - setIntervalTime
```
public void setIntervalTime(Integer IntervalTime)
```
    设置健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    IntervalTime - 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
  - getHealthNum
```
public Integer getHealthNum()
```
    获取健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HealthNum 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - setHealthNum
```
public void setHealthNum(Integer HealthNum)
```
    设置健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HealthNum - 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - getUnHealthNum
```
public Integer getUnHealthNum()
```
    获取不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    UnHealthNum 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - setUnHealthNum
```
public void setUnHealthNum(Integer UnHealthNum)
```
    设置不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    UnHealthNum - 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - getHttpCode
```
public Integer getHttpCode()
```
    获取健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：TCP监听器的HTTP健康检查方式，只支持指定一种健康检查状态码。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HttpCode 健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：TCP监听器的HTTP健康检查方式，只支持指定一种健康检查状态码。注意：此字段可能返回 null，表示取不到有效值。
  - setHttpCode
```
public void setHttpCode(Integer HttpCode)
```
    设置健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：TCP监听器的HTTP健康检查方式，只支持指定一种健康检查状态码。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HttpCode - 健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：TCP监听器的HTTP健康检查方式，只支持指定一种健康检查状态码。注意：此字段可能返回 null，表示取不到有效值。
  - getHttpCheckPath
```
public String getHttpCheckPath()
```
    获取健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HttpCheckPath 健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
  - setHttpCheckPath
```
public void setHttpCheckPath(String HttpCheckPath)
```
    设置健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HttpCheckPath - 健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
  - getHttpCheckDomain
```
public String getHttpCheckDomain()
```
    获取健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HttpCheckDomain 健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
  - setHttpCheckDomain
```
public void setHttpCheckDomain(String HttpCheckDomain)
```
    设置健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HttpCheckDomain - 健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
  - getHttpCheckMethod
```
public String getHttpCheckMethod()
```
    获取健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HttpCheckMethod 健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
  - setHttpCheckMethod
```
public void setHttpCheckMethod(String HttpCheckMethod)
```
    设置健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HttpCheckMethod - 健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
  - getCheckPort
```
public Integer getCheckPort()
```
    获取自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    CheckPort 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - setCheckPort
```
public void setCheckPort(Integer CheckPort)
```
    设置自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    CheckPort - 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - getContextType
```
public String getContextType()
```
    获取自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器）注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    ContextType 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器）注意：此字段可能返回 null，表示取不到有效值。
  - setContextType
```
public void setContextType(String ContextType)
```
    设置自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器）注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    ContextType - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器）注意：此字段可能返回 null，表示取不到有效值。
  - getSendContext
```
public String getSendContext()
```
    获取自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    SendContext 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - setSendContext
```
public void setSendContext(String SendContext)
```
    设置自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    SendContext - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - getRecvContext
```
public String getRecvContext()
```
    获取自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    RecvContext 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - setRecvContext
```
public void setRecvContext(String RecvContext)
```
    设置自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    RecvContext - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
  - getCheckType
```
public String getCheckType()
```
    获取自定义探测相关参数。健康检查使用的协议：TCP | HTTP | CUSTOM（仅适用于TCP/UDP监听器，其中UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    CheckType 自定义探测相关参数。健康检查使用的协议：TCP | HTTP | CUSTOM（仅适用于TCP/UDP监听器，其中UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
  - setCheckType
```
public void setCheckType(String CheckType)
```
    设置自定义探测相关参数。健康检查使用的协议：TCP | HTTP | CUSTOM（仅适用于TCP/UDP监听器，其中UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    CheckType - 自定义探测相关参数。健康检查使用的协议：TCP | HTTP | CUSTOM（仅适用于TCP/UDP监听器，其中UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
  - getHttpVersion
```
public String getHttpVersion()
```
    获取自定义探测相关参数。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器）注意：此字段可能返回 null，表示取不到有效值。
    
    返回:
    
    HttpVersion 自定义探测相关参数。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器）注意：此字段可能返回 null，表示取不到有效值。
  - setHttpVersion
```
public void setHttpVersion(String HttpVersion)
```
    设置自定义探测相关参数。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器）注意：此字段可能返回 null，表示取不到有效值。
    
    参数:
    
    HttpVersion - 自定义探测相关参数。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器）注意：此字段可能返回 null，表示取不到有效值。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    内部实现，用户禁止调用
    
    指定者:
    
    toMap 在类中 AbstractModel

类 HealthCheck

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractModel

从类继承的方法 java.lang.Object

构造器详细资料

HealthCheck

方法详细资料

getHealthSwitch

setHealthSwitch

getTimeOut

setTimeOut

getIntervalTime

setIntervalTime

getHealthNum

setHealthNum

getUnHealthNum

setUnHealthNum

getHttpCode

setHttpCode

getHttpCheckPath

setHttpCheckPath

getHttpCheckDomain

setHttpCheckDomain

getHttpCheckMethod

setHttpCheckMethod

getCheckPort

setCheckPort

getContextType

setContextType

getSendContext

setSendContext

getRecvContext

setRecvContext

getCheckType

setCheckType

getHttpVersion

setHttpVersion

toMap