REST API for Oracle Private Cloud Appliance Compute Enclave

Get a Health Checker

get

/20170115/loadBalancers/{load_balancer_id}/backendSets/{backend_set_name}/healthChecker

Get the health check policy information for a given load balancer and backend set.

Request

Supported Media Types

application/json

Path Parameters

backendSetName(required): string

The name of the backend set associated with the health check policy to be retrieved. Example: `example_backend_set`
loadBalancerId(required): string

The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be retrieved.

Header Parameters

if-match: string

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer. For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets. The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value. Example: `example-etag`

Default Value:
opc-request-id: string

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Default Value:

Response

Supported Media Types

application/json

200 Response

The health check policy information is being retrieved.

Headers

eTag: string

Reflects the current version of the load balancer and the resources it contains. The value only changes when the load balancer or an associated resource is created, updated, or delete For optimistic concurrency control. See `if-match`.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : HealthChecker

Type: object

The health check policy configuration.

Show Source

dns: object DnsHealthCheckerDetails

DNS healthcheck configurations.
intervalInMillis: integer(int32)

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

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

Example: 8080
protocol(required): string

Allowed Values: [ "HTTP", "HTTPS", "TCP", "UDP", "DNS" ]

The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
requestData: string(byte)

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

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

Base64 encoded pattern to be validated as UDP or TCP health check probe response.
retries: integer(int32)

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.
returnCode: integer(int32)

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: 0
timeoutInMillis: integer(int32)

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).
urlPath: string

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

{
    "type":"object",
    "required":[
        "protocol"
    ],
    "properties":{
        "protocol":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/HealthCheckProtocols",
            "enum":[
                "HTTP",
                "HTTPS",
                "TCP",
                "UDP",
                "DNS"
            ],
            "description":"The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP."
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "example":"8080",
            "description":"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 "
        },
        "retries":{
            "type":"integer",
            "format":"int32",
            "description":"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."
        },
        "timeoutInMillis":{
            "type":"integer",
            "format":"int32",
            "description":"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)."
        },
        "intervalInMillis":{
            "type":"integer",
            "format":"int32",
            "description":"The interval between health checks, in milliseconds. The default value is 10000 (10 seconds)."
        },
        "urlPath":{
            "type":"string",
            "description":"The path against which to run the health check. Example: /healthcheck "
        },
        "responseBodyRegex":{
            "type":"string",
            "description":"A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\\s)*$ "
        },
        "returnCode":{
            "type":"integer",
            "format":"int32",
            "example":0,
            "description":"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."
        },
        "requestData":{
            "type":"string",
            "format":"byte",
            "description":"Base64 encoded pattern to be sent as UDP or TCP health check probe."
        },
        "responseData":{
            "type":"string",
            "format":"byte",
            "description":"Base64 encoded pattern to be validated as UDP or TCP health check probe response."
        },
        "dns":{
            "$ref":"#/definitions/DnsHealthCheckerDetails"
        }
    },
    "description":"The health check policy configuration.",
    "x-example":"{   \"protocol\": \"HTTP\",   \"port\": 8080,   \"timeoutInMillis\": 3000,   \"intervalInMillis\": 10000,   \"retries\": 3,   \"urlPath\": \"/healthcheck\",   \"returnCode\": 200,   \"responseBodyRegex\": \"^((?!false).|\\s)*$\" } or {   \"protocol\": \"UDP\",   \"port\": 8080,   \"timeoutInMillis\": 3000,   \"intervalInMillis\": 10000,   \"retries\": 3,   \"requestData\": \"4wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",   \"responseData\": \"JA==\" } or {   \"protocol\": \"DNS\",   \"port\": 53,   \"timeoutInMillis\": 1000,   \"intervalInMillis\": 10000,   \"retries\": 2,   \"dns\": {     \"transportProtocol\": \"UDP\",     \"domainName\": \"www.oracle.com\",     \"queryClass\": \"IN\",     \"queryType\": \"A\",     \"rcodes\": [\"NOERROR\", \"NXDOMAIN\"]   } } "
}

Nested Schema : DnsHealthCheckerDetails

Type: object

DNS healthcheck configurations.

Show Source

domainName(required): string

Minimum Length: 1

Maximum Length: 255

The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
queryClass: string

Allowed Values: [ "IN", "CH" ]

The class the dns health check query to use; either IN or CH. Example: `IN`
queryType: string

Allowed Values: [ "A", "TXT", "AAAA" ]

The type the dns health check query to use; A, AAAA, TXT. Example: `A`
rcodes: array rcodes

Minimum Number of Items: 1

Unique Items Required: true

An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
transportProtocol: string

Allowed Values: [ "UDP", "TCP" ]

DNS transport protocol; either UDP or TCP. Example: `UDP`

{
    "type":"object",
    "description":"DNS healthcheck configurations.",
    "required":[
        "domainName"
    ],
    "properties":{
        "transportProtocol":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DnsHealthCheckTransportProtocols",
            "enum":[
                "UDP",
                "TCP"
            ],
            "description":"DNS transport protocol; either UDP or TCP.  Example: `UDP` "
        },
        "domainName":{
            "type":"string",
            "description":"The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. ",
            "minLength":1,
            "maxLength":255
        },
        "queryClass":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DnsHealthCheckQueryClasses",
            "enum":[
                "IN",
                "CH"
            ],
            "description":"The class the dns health check query to use; either IN or CH.  Example: `IN` "
        },
        "queryType":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DnsHealthCheckQueryTypes",
            "enum":[
                "A",
                "TXT",
                "AAAA"
            ],
            "description":"The type the dns health check query to use; A, AAAA, TXT.  Example: `A` "
        },
        "rcodes":{
            "type":"array",
            "uniqueItems":true,
            "minItems":1,
            "description":"An array that represents accepetable RCODE values for DNS query response. Example: [\"NOERROR\", \"NXDOMAIN\"] ",
            "items":{
                "$ref":"#/definitions/DnsHealthCheckRCodes"
            }
        }
    }
}

Nested Schema : rcodes

Type: array

Minimum Number of Items: 1

Unique Items Required: true

An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]

Show Source

Array of: string

Allowed Values: [ "NOERROR", "SERVFAIL", "NXDOMAIN", "REFUSED" ]

Return code value to validate the DNS response in healthcheck.

{
    "type":"array",
    "uniqueItems":true,
    "minItems":1,
    "description":"An array that represents accepetable RCODE values for DNS query response. Example: [\"NOERROR\", \"NXDOMAIN\"] ",
    "items":{
        "$ref":"#/definitions/DnsHealthCheckRCodes"
    }
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

412 Response

Precondition Failed

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}