Class: TencentCloud::Apigateway::V20180808::UpstreamHealthChecker

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20180808/models.rb

Overview

后端通道健康检查参数配置

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enableactivecheck = nil, enablepassivecheck = nil, healthyhttpstatus = nil, unhealthyhttpstatus = nil, tcpfailurethreshold = nil, timeoutthreshold = nil, httpfailurethreshold = nil, activecheckhttppath = nil, activechecktimeout = nil, activecheckinterval = nil, activerequestheader = nil, unhealthytimeout = nil) ⇒ UpstreamHealthChecker

Returns a new instance of UpstreamHealthChecker.



9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
# File 'lib/v20180808/models.rb', line 9562

def initialize(enableactivecheck=nil, enablepassivecheck=nil, healthyhttpstatus=nil, unhealthyhttpstatus=nil, tcpfailurethreshold=nil, timeoutthreshold=nil, httpfailurethreshold=nil, activecheckhttppath=nil, activechecktimeout=nil, activecheckinterval=nil, activerequestheader=nil, unhealthytimeout=nil)
  @EnableActiveCheck = enableactivecheck
  @EnablePassiveCheck = enablepassivecheck
  @HealthyHttpStatus = healthyhttpstatus
  @UnhealthyHttpStatus = unhealthyhttpstatus
  @TcpFailureThreshold = tcpfailurethreshold
  @TimeoutThreshold = timeoutthreshold
  @HttpFailureThreshold = httpfailurethreshold
  @ActiveCheckHttpPath = activecheckhttppath
  @ActiveCheckTimeout = activechecktimeout
  @ActiveCheckInterval = activecheckinterval
  @ActiveRequestHeader = activerequestheader
  @UnhealthyTimeout = unhealthytimeout
end

Instance Attribute Details

#ActiveCheckHttpPathObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def ActiveCheckHttpPath
  @ActiveCheckHttpPath
end

#ActiveCheckIntervalObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def ActiveCheckInterval
  @ActiveCheckInterval
end

#ActiveCheckTimeoutObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def ActiveCheckTimeout
  @ActiveCheckTimeout
end

#ActiveRequestHeaderObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def ActiveRequestHeader
  @ActiveRequestHeader
end

#EnableActiveCheckObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def EnableActiveCheck
  @EnableActiveCheck
end

#EnablePassiveCheckObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def EnablePassiveCheck
  @EnablePassiveCheck
end

#HealthyHttpStatusObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def HealthyHttpStatus
  @HealthyHttpStatus
end

#HttpFailureThresholdObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def HttpFailureThreshold
  @HttpFailureThreshold
end

#TcpFailureThresholdObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def TcpFailureThreshold
  @TcpFailureThreshold
end

#TimeoutThresholdObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def TimeoutThreshold
  @TimeoutThreshold
end

#UnhealthyHttpStatusObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def UnhealthyHttpStatus
  @UnhealthyHttpStatus
end

#UnhealthyTimeoutObject

Parameters:

  • EnableActiveCheck:

    标识是否开启主动健康检查。

  • EnablePassiveCheck:

    标识是否开启被动健康检查。

  • HealthyHttpStatus:

    健康检查时,判断为成功请求的 HTTP 状态码。

  • UnhealthyHttpStatus:

    健康检查时,判断为失败请求的 HTTP 状态码。

  • TcpFailureThreshold:

    TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。

  • TimeoutThreshold:

    连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。

  • HttpFailureThreshold:

    HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。

  • ActiveCheckHttpPath:

    主动健康检查时探测请求的路径。默认为“/”。

  • ActiveCheckTimeout:

    主动健康检查的探测请求超时,单位秒。默认为5秒。

  • ActiveCheckInterval:

    主动健康检查的时间间隔,默认5秒。

  • ActiveRequestHeader:

    主动健康检查时探测请求的的请求头。

  • UnhealthyTimeout:

    异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。



9560
9561
9562
# File 'lib/v20180808/models.rb', line 9560

def UnhealthyTimeout
  @UnhealthyTimeout
end

Instance Method Details

#deserialize(params) ⇒ Object



9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
# File 'lib/v20180808/models.rb', line 9577

def deserialize(params)
  @EnableActiveCheck = params['EnableActiveCheck']
  @EnablePassiveCheck = params['EnablePassiveCheck']
  @HealthyHttpStatus = params['HealthyHttpStatus']
  @UnhealthyHttpStatus = params['UnhealthyHttpStatus']
  @TcpFailureThreshold = params['TcpFailureThreshold']
  @TimeoutThreshold = params['TimeoutThreshold']
  @HttpFailureThreshold = params['HttpFailureThreshold']
  @ActiveCheckHttpPath = params['ActiveCheckHttpPath']
  @ActiveCheckTimeout = params['ActiveCheckTimeout']
  @ActiveCheckInterval = params['ActiveCheckInterval']
  unless params['ActiveRequestHeader'].nil?
    @ActiveRequestHeader = []
    params['ActiveRequestHeader'].each do |i|
      upstreamhealthcheckerreqheaders_tmp = UpstreamHealthCheckerReqHeaders.new
      upstreamhealthcheckerreqheaders_tmp.deserialize(i)
      @ActiveRequestHeader << upstreamhealthcheckerreqheaders_tmp
    end
  end
  @UnhealthyTimeout = params['UnhealthyTimeout']
end