Class BackendSetHealth

The health status details for a backend set.
This object does not explicitly enumerate backend servers with a status of OK. However, the backend sets are included in the totalBackendCount sum.

Inheritance

object

BackendSetHealth

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 BackendSetHealth

Properties

CriticalStateBackendNames

Declaration

[Required(ErrorMessage = "CriticalStateBackendNames is required.")]
[JsonProperty(PropertyName = "criticalStateBackendNames")]
public List<string> CriticalStateBackendNames { get; set; }

Property Value

Type	Description
List<string>	A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port. Example: 10.0.0.4:8080

Remarks

Required

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BackendSetHealth.StatusEnum? Status { get; set; }

Property Value

Type Description

Type	Description
BackendSetHealth.StatusEnum?	Overall health status of the backend set. OK: All backend servers in the backend set return a status of `OK`. WARNING: Half or more of the backend servers in a backend set return a status of `OK` and at least one backend server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`. CRITICAL: Fewer than half of the backend servers in a backend set return a status of `OK`. UNKNOWN: If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends.

BackendSetHealth.StatusEnum?

Overall health status of the backend set.

OK: All backend servers in the backend set return a status of OK.
WARNING: Half or more of the backend servers in a backend set return a status of OK and at least one backend server returns a status of WARNING, CRITICAL, or UNKNOWN.
CRITICAL: Fewer than half of the backend servers in a backend set return a status of OK.
UNKNOWN: If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends.

Remarks

Required

TotalBackendCount

Declaration

[Required(ErrorMessage = "TotalBackendCount is required.")]
[JsonProperty(PropertyName = "totalBackendCount")]
public int? TotalBackendCount { get; set; }

Property Value

Type	Description
int?	The total number of backend servers in this backend set. Example: 7

Remarks

Required

UnknownStateBackendNames

Declaration

[Required(ErrorMessage = "UnknownStateBackendNames is required.")]
[JsonProperty(PropertyName = "unknownStateBackendNames")]
public List<string> UnknownStateBackendNames { get; set; }

Property Value

Type	Description
List<string>	A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port. Example: 10.0.0.5:8080

Remarks

Required

WarningStateBackendNames

Declaration

[Required(ErrorMessage = "WarningStateBackendNames is required.")]
[JsonProperty(PropertyName = "warningStateBackendNames")]
public List<string> WarningStateBackendNames { get; set; }

Property Value

Type	Description
List<string>	A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address or OCID and port. Example: 10.0.0.3:8080 or ocid1.privateip..oc1.`<unique_ID>`:8080

Remarks

Required