Class HealthChecker

The health check policy configuration. For more information, see Editing Network Load Balancer Health Check Policies.

Inheritance
object
HealthChecker
Inherited Members
Namespace: Oci.NetworkloadbalancerService.Models
Assembly: OCI.DotNetSDK.Networkloadbalancer.dll
Syntax
public class HealthChecker

Properties

Dns

Declaration
[JsonProperty(PropertyName = "dns")]
public DnsHealthCheckerDetails Dns { get; set; }
Property Value
Type Description
DnsHealthCheckerDetails

IntervalInMillis

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

The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
Example: 10000

Port

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

The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0.
Example: 8080

Protocol

Declaration
[Required(ErrorMessage = "Protocol is required.")]
[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HealthCheckProtocols? Protocol { get; set; }
Property Value
Type Description
HealthCheckProtocols?

The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
Example: HTTP
Remarks

Required

RequestData

Declaration
[JsonProperty(PropertyName = "requestData")]
public byte[] RequestData { get; set; }
Property Value
Type Description
byte[]

Base64 encoded pattern to be sent as UDP or TCP health check probe.

ResponseBodyRegex

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

A regular expression for parsing the response body from the backend server.
Example: ^((?!false).|\s)*$

ResponseData

Declaration
[JsonProperty(PropertyName = "responseData")]
public byte[] ResponseData { get; set; }
Property Value
Type Description
byte[]

Base64 encoded pattern to be validated as UDP or TCP health check probe response.

Retries

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

The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3.
Example: 3

ReturnCode

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

The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200".
Example: 200

TimeoutInMillis

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

The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds).
Example: 3000

UrlPath

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

The path against which to run the health check.
Example: /healthcheck