Jump to

• Request
• Response

GetBackendSetHealth

get

/20200501/networkLoadBalancers/{network_load_balancer_id}/backendSets/{backend_set_name}/health

Retrieves the health status for the specified backend set.

Request

Supported Media Types

• application/json

Path Parameters

• backendSetName(required): string
  The name of the backend set for which to retrieve the health status. Example: example_backend_set
• networkLoadBalancerId(required): string
  The OCID of the network load balancer to update.

  Default Value:

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieved the health status information.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : BackendSetHealth

Type: object

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.

Show Source

• criticalStateBackendNames(required): array criticalStateBackendNames
  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
• status(required): string
  Allowed Values: [ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]

  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.
• totalBackendCount(required): integer
  The total number of backend servers in this backend set. Example: 7
• unknownStateBackendNames(required): array unknownStateBackendNames
  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
• warningStateBackendNames(required): array warningStateBackendNames
  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..unique_ID:8080

{
    "type":"object",
    "required":[
        "status",
        "warningStateBackendNames",
        "criticalStateBackendNames",
        "unknownStateBackendNames",
        "totalBackendCount"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"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."
        },
        "warningStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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..<var>unique_ID</var>:8080 "
        },
        "criticalStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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 "
        },
        "unknownStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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 "
        },
        "totalBackendCount":{
            "type":"integer",
            "description":"The total number of backend servers in this backend set. Example: 7 "
        }
    },
    "description":"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.",
    "x-example":"{   \"status\": \"WARNING\",   \"warningStateBackendNames\": [     \"10.0.0.3:8080\"   ],   \"criticalStateBackendNames\": [     \"10.0.0.4:8080\"   ],   \"unknownStateBackendNames\": [     \"ocid1.privateip..<var>unique_ID</var>\"   ],   \"totalBackendCount\": 7 } "
}

Nested Schema : criticalStateBackendNames

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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 "
}

Nested Schema : unknownStateBackendNames

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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 "
}

Nested Schema : warningStateBackendNames

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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..<var>unique_ID</var>:8080 "
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

412 Response

Precondition Failed

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top