Class HealthCheck

Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy".

Inheritance
object
HealthCheck
Inherited Members
Namespace: Oci.WaasService.Models
Assembly: OCI.DotNetSDK.Waas.dll
Syntax
public class HealthCheck

Properties

ExpectedResponseCodeGroup

Declaration
[JsonProperty(PropertyName = "expectedResponseCodeGroup", ItemConverterType = typeof(ResponseEnumConverter))]
public List<HealthCheck.ExpectedResponseCodeGroupEnum> ExpectedResponseCodeGroup { get; set; }
Property Value
Type Description
List<HealthCheck.ExpectedResponseCodeGroupEnum>

The HTTP response codes that signify a healthy state.

  • 2XX: Success response code group.
  • 3XX: Redirection response code group.
  • 4XX: Client errors response code group.
  • 5XX: Server errors response code group.

ExpectedResponseText

Declaration
[JsonProperty(PropertyName = "expectedResponseText")]
public string ExpectedResponseText { get; set; }
Property Value
Type Description
string

Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found.

Headers

Declaration
[JsonProperty(PropertyName = "headers")]
public Dictionary<string, string> Headers { get; set; }
Property Value
Type Description
Dictionary<string, string>

HTTP header fields to include in health check requests, expressed as \"name\": \"value\" properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value "waf health checks".
Note: The only currently-supported header fields are Host and User-Agent.

HealthyThreshold

Declaration
[JsonProperty(PropertyName = "healthyThreshold")]
public int? HealthyThreshold { get; set; }
Property Value
Type Description
int?

Number of successful health checks after which the server is marked up.

IntervalInSeconds

Declaration
[JsonProperty(PropertyName = "intervalInSeconds")]
public int? IntervalInSeconds { get; set; }
Property Value
Type Description
int?

Time between health checks of an individual origin server, in seconds.

IsEnabled

Declaration
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type Description
bool?

Enables or disables the health checks.

IsResponseTextCheckEnabled

Declaration
[JsonProperty(PropertyName = "isResponseTextCheckEnabled")]
public bool? IsResponseTextCheckEnabled { get; set; }
Property Value
Type Description
bool?

Enables or disables additional check for predefined text in addition to response code.

Method

Declaration
[JsonProperty(PropertyName = "method")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HealthCheck.MethodEnum? Method { get; set; }
Property Value
Type Description
HealthCheck.MethodEnum?

An HTTP verb (i.e. HEAD, GET, or POST) to use when performing the health check.

Path

Declaration
[JsonProperty(PropertyName = "path")]
public string Path { get; set; }
Property Value
Type Description
string

Path to visit on your origins when performing the health check.

TimeoutInSeconds

Declaration
[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }
Property Value
Type Description
int?

Response timeout represents wait time until request is considered failed, in seconds.

UnhealthyThreshold

Declaration
[JsonProperty(PropertyName = "unhealthyThreshold")]
public int? UnhealthyThreshold { get; set; }
Property Value
Type Description
int?

Number of failed health checks after which the server is marked down.