Jump to

• Request
• Response

UpdateHealthChecker

put

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

Updates the health check policy for a given network 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
• networkLoadBalancerId(required): string
  The OCID of the network load balancer to update.

  Default Value:

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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

The health check policy configuration details.

Root Schema : UpdateHealthCheckerDetails

Type: object

The configuration details of the health checker.

Show Source

• intervalInMillis: integer(int32)
  Minimum Value: 1000

  Maximum Value: 1800000

  The interval between health checks, in milliseconds. Example: 10000
• port: integer(int32)
  Minimum Value: 0

  Maximum Value: 65535

  The backend server port against which to run the health check. Example: 8080
• protocol: string
  Allowed Values: [ "HTTP", "HTTPS", "TCP", "UDP" ]

  The protocol that the health check must use; either HTTP, UDP, or TCP. Example: HTTP
• 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. Example: 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: 200

  Example: 0
• timeoutInMillis: integer(int32)
  Minimum Value: 1

  Maximum Value: 600000

  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: string
  The path against which to run the health check. Example: /healthcheck

{
    "type":"object",
    "properties":{
        "protocol":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/HealthCheckProtocols",
            "enum":[
                "HTTP",
                "HTTPS",
                "TCP",
                "UDP"
            ],
            "description":"The protocol that the health check must use; either HTTP, UDP, or TCP. Example: HTTP "
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "minimum":"0",
            "maximum":"65535",
            "description":"The backend server port against which to run the health check. 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. Example: 3 "
        },
        "timeoutInMillis":{
            "type":"integer",
            "format":"int32",
            "minimum":"1",
            "maximum":"600000",
            "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. Example: 3000 "
        },
        "intervalInMillis":{
            "type":"integer",
            "format":"int32",
            "minimum":"1000",
            "maximum":"1800000",
            "description":"The interval between health checks, in milliseconds. Example: 10000 "
        },
        "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\". Example: 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."
        }
    },
    "description":"The configuration details of the health checker.",
    "x-example":"{   \"protocol\": \"HTTP\",   \"port\": 8080,   \"timeoutInMillis\": 3000,   \"intervalInMillis\": 10000,   \"retries\": 3,   \"urlPath\": \"/healthcheck\",   \"returnCode\": 200,   \"responseBodyRegex\": \"^((?!false).|\\s)*$\" } "
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request accepted for processing.

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.
• opc-work-request-id: string
  Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

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