Jump to

• Request
• Response

CreateBackendSet

post

/20170115/loadBalancers/{load_balancer_id}/backendSets

Adds a backend set to a load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The OCID of the load balancer on which to add a backend set.

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 is updated or deleted only if the ETag you provide matches the resource's current ETag value.

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

  Default Value:
• 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 details for adding a backend set.

Root Schema : CreateBackendSetDetails

Type: object

The configuration details for creating a backend set in a network load balancer. Avoid entering confidential information when you supply string values using the API.

Show Source

• backends: array backends
  Unique Items Required: true

  An array of backends to be associated with the backend set.
• healthChecker(required): object HealthCheckerDetails
  The health check policy configuration.
• ipVersion: string
  Default Value: IPV4

  Allowed Values: [ "IPV4", "IPV6" ]

  IP version associated with the backend set.
• isPreserveSource: boolean
  Default Value: true

  If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.
• name(required): string
  Minimum Length: 1

  Maximum Length: 32

  A user-friendly name for the backend set that must be unique and cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
• policy(required): string
  Default Value: FIVE_TUPLE

  Allowed Values: [ "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE" ]

  The network load balancer policy for the backend set. Example: FIVE_TUPLE

{
    "type":"object",
    "required":[
        "name",
        "policy",
        "healthChecker"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"32",
            "description":"A user-friendly name for the backend set that must be unique and cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information."
        },
        "policy":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/NetworkLoadBalancingPolicy",
            "default":"FIVE_TUPLE",
            "enum":[
                "TWO_TUPLE",
                "THREE_TUPLE",
                "FIVE_TUPLE"
            ],
            "description":"The network load balancer policy for the backend set. Example: FIVE_TUPLE "
        },
        "isPreserveSource":{
            "type":"boolean",
            "description":"If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.",
            "default":true
        },
        "ipVersion":{
            "description":"IP version associated with the backend set.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "backends":{
            "type":"array",
            "uniqueItems":true,
            "description":"An array of backends to be associated with the backend set.",
            "items":{
                "$ref":"#/definitions/BackendDetails"
            }
        },
        "healthChecker":{
            "$ref":"#/definitions/HealthCheckerDetails"
        }
    },
    "description":"The configuration details for creating a backend set in a network load balancer. Avoid entering confidential information when you supply string values using the API.",
    "x-example":"{   \"name\": \"example_backend_set\",   \"policy\": \"FIVE_TUPLE\",   \"ipVersion\": \"IPV4\",   \"backends\": [     {       \"ipAddress\": \"10.0.0.3\",       \"port\": 8080,        \"isBackup\": false,       \"isDrain\": false,       \"isOffline\": false     },     {       \"ipAddress\": \"10.0.0.4\",       \"port\": 8080,       \"isBackup\": false,       \"isDrain\": false,       \"isOffline\": false     }   ],   \"healthChecker\": {     \"protocol\": \"HTTP\",     \"port\": 8080,     \"timeoutInMillis\": 3000,     \"intervalInMillis\": 10000,     \"urlPath\": \"/healthcheck\",     \"returnCode\": 200,     \"retries\": 3,     \"responseBodyRegex\": \"^((?!false).|\\s)*$\"   }, } "
}

Nested Schema : backends

Type: array

Unique Items Required: true

An array of backends to be associated with the backend set.

Show Source

• Array of: object BackendDetails
  The network network load balancing configuration details of a backend server.

{
    "type":"array",
    "uniqueItems":true,
    "description":"An array of backends to be associated with the backend set.",
    "items":{
        "$ref":"#/definitions/BackendDetails"
    }
}

Nested Schema : HealthCheckerDetails

Type: object

The health check policy configuration.

Show Source

• intervalInMillis: integer(int32)
  Default Value: 10000

  The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000
• 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" ]

  The protocol the health check must use; either HTTP or HTTPS, or 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)
  Default Value: 3

  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. 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: 200
• timeoutInMillis: integer(int32)
  Default Value: 3000

  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). Example: 3000
• 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"
            ],
            "description":"The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP "
        },
        "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",
            "default":"3",
            "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. Example: 3 "
        },
        "timeoutInMillis":{
            "type":"integer",
            "format":"int32",
            "default":"3000",
            "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). Example: 3000 "
        },
        "intervalInMillis":{
            "type":"integer",
            "format":"int32",
            "default":"10000",
            "description":"The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). 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":"200",
            "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 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==\" } "
}

Nested Schema : BackendDetails

Type: object

The network network load balancing configuration details of a backend server.

Show Source

• ipAddress: string
  The IP address of the backend server. Example: 10.0.0.3
• ipVersion: string
  Default Value: IPV4

  Allowed Values: [ "IPV4", "IPV6" ]

  IP version associated with the BackendDetails object.
• isBackup: boolean
  Default Value: false

  Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
• isDrain: boolean
  Default Value: false

  Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
• isOffline: boolean
  Default Value: false

  Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
• name: string
  A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..unique_ID:443 or 10.0.0.3:0
• port(required): integer(int32)
  Minimum Value: 0

  Maximum Value: 65535

  The communication port for the backend server. Example: 8080
• targetId: string
  The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..unique_ID
• weight: integer(int32)
  Minimum Value: 1

  Maximum Value: 100

  Default Value: 1

  The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. Example: 3

{
    "type":"object",
    "required":[
        "port"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..<var>unique_ID</var>:443 or 10.0.0.3:0 "
        },
        "ipVersion":{
            "description":"IP version associated with the BackendDetails object.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "ipAddress":{
            "type":"string",
            "x-default-description":"If the targetId is not specified and the IP address is also not specified, then this is an invalid backend.",
            "description":"The IP address of the backend server. Example: 10.0.0.3 "
        },
        "targetId":{
            "type":"string",
            "description":"The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..<var>unique_ID</var> "
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "minimum":"0",
            "maximum":"65535",
            "description":"The communication port for the backend server. Example: 8080 "
        },
        "weight":{
            "type":"integer",
            "format":"int32",
            "minimum":"1",
            "maximum":"100",
            "default":"1",
            "description":"The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. Example: 3 "
        },
        "isBackup":{
            "type":"boolean",
            "default":false,
            "description":"Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"isBackup\" fail the health check policy. Example: false "
        },
        "isDrain":{
            "type":"boolean",
            "default":false,
            "description":"Whether the network load balancer should drain this server. Servers marked \"isDrain\" receive no  incoming traffic. Example: false "
        },
        "isOffline":{
            "type":"boolean",
            "default":false,
            "description":"Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false "
        }
    },
    "description":"The network network load balancing configuration details of a backend server.",
    "x-example":"{   \"ipAddress\": \"10.0.0.3\",   \"port\": 8080,   \"isBackup\": false,   \"isDrain\": false,   \"ipVersion\": \"IPV4\",   \"isOffline\": false } "
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

The request was accepted for processing.

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.
• opc-work-request-id: string
  The OCID of the work request.

304 Response

Not Modified

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

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

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

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

An error has occurred.

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