Show / Hide Table of Contents

Class UpdateHealthCheckerDetails

The configuration details of the health checker.

Inheritance
object
UpdateHealthCheckerDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.NetworkloadbalancerService.Models
Assembly: OCI.DotNetSDK.Networkloadbalancer.dll
Syntax
public class UpdateHealthCheckerDetails

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.
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.
Example: 8080

Protocol

Declaration
[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(StringEnumConverter))]
public HealthCheckProtocols? Protocol { get; set; }
Property Value
Type Description
HealthCheckProtocols?

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

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.
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.
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

In this article
Back to top