Jump to

• Request
• Response

GetNetworkLoadBalancerHealth

get

/20200501/networkLoadBalancers/{network_load_balancer_id}/health

Retrieves the health status for the specified network load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• 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

• 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 : NetworkLoadBalancerHealth

Type: object

The health status details for the specified network load balancer. This object does not explicitly enumerate backend sets with a status of OK. However, the backend sets are included in the totalBackendSetCount sum.

Show Source

• criticalStateBackendSetNames(required): array criticalStateBackendSetNames
  A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.
• status(required): string
  Allowed Values: [ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]

  The overall health status of the network load balancer.
• OK: All backend sets associated with the network load balancer return a status of OK.
• WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.
• CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.
• UNKNOWN: Any one of the following conditions is true: The network load balancer life cycle state is not ACTIVE; no backend sets are defined for the network load balancer; more than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE; the system could not retrieve metrics for any reason.

totalBackendSetCount(required): integer

The total number of backend sets associated with this network load balancer. Example: 4

unknownStateBackendSetNames(required): array unknownStateBackendSetNames

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

warningStateBackendSetNames(required): array warningStateBackendSetNames

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

{
    "type":"object",
    "required":[
        "status",
        "warningStateBackendSetNames",
        "criticalStateBackendSetNames",
        "unknownStateBackendSetNames",
        "totalBackendSetCount"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"The overall health status of the network load balancer.<li>OK: All backend sets associated with the network load balancer return a status of OK.<li>WARNING: At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.<li>CRITICAL: One or more of the backend sets associated with the network load balancer return a status of CRITICAL.<li>UNKNOWN: Any one of the following conditions is true: The network load balancer life cycle state is not ACTIVE; no backend sets are defined for the network load balancer; more than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE; the system could not retrieve metrics for any reason."
        },
        "warningStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
        },
        "criticalStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
        },
        "unknownStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
        },
        "totalBackendSetCount":{
            "type":"integer",
            "description":"The total number of backend sets associated with this network load balancer. Example: 4 "
        }
    },
    "description":"The health status details for the specified network load balancer. This object does not explicitly enumerate backend sets with a status of OK. However, the backend sets are included in the totalBackendSetCount sum.",
    "x-example":"{   \"status\": \"CRITICAL\",   \"warningStateBackendSetNames\": [     \"example_backend_set3\"   ],   \"criticalStateBackendSetNames\": [     \"example_backend_set\"   ],   \"unknownStateBackendSetNames\": [     \"example_backend_set2\"   ],   \"totalBackendSetCount\": 4 } "
}

Nested Schema : criticalStateBackendSetNames

Type: array

A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
}

Nested Schema : unknownStateBackendSetNames

Type: array

A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
}

Nested Schema : warningStateBackendSetNames

Type: array

A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set."
}

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