Jump to

• Request
• Response

GetNetworkLoadBalancer

get

/20200501/networkLoadBalancers/{network_load_balancer_id}

Retrieve network load balancer configuration information by identifier.

Request

Supported Media Types

• application/json

Path Parameters

• networkLoadBalancerId(required): string
  The OCID of the network load balancer to update.

  Default Value:

Header Parameters

• if-none-match: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^[*]$

  The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag
• 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

Retrieving the network load balancer with the given identifier.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Body ()

Root Schema : NetworkLoadBalancer

Type: object

The properties that define a network load balancer. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator.

Show Source

• backendSets: object backendSets
  Additional Properties Allowed: BackendSet

  Backend sets associated with the network load balancer.
• compartmentId(required): string
  The OCID of the compartment containing the network load balancer.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName(required): string
  A user-friendly name, which does not need to be unique, and can be changed.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  The OCID of the network load balancer.
• ipAddresses(required): array ipAddresses
  Unique Items Required: true

  An array of IP addresses.
• isPreserveSourceDestination: boolean
  Default Value: false

  When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
• isPrivate: boolean
  Default Value: true

  Whether the network load balancer has a virtual cloud network-local (private) IP address. If "true", then the service assigns a private IP address to the network load balancer. If "false", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending the security list rules for your virtual cloudn network. This value is true by default. Example: true
• isSymmetricHashEnabled: boolean
  Default Value: false

  This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
• lifecycleDetails: string
  A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the network load balancer.
• listeners: object listeners
  Additional Properties Allowed: Listener

  Listeners associated with the network load balancer.
• networkSecurityGroupIds: array networkSecurityGroupIds
  Maximum Number of Items: 5

  An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
• nlbIpVersion: string
  Default Value: IPV4

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

  IP version associated with the NLB.
• subnetId(required): string
  The OCID of the subnet in which the network load balancer is spawned."
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
• timeCreated(required): string(date-time)
  The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
• timeUpdated: string(date-time)
  The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

{
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"NetworkLoadBalancer",
        "ocidEntityType":"networkloadbalancer",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE",
            "FAILED"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetNetworkLoadBalancer",
        "listResourcesOperationId":"ListNetworkLoadBalancers",
        "workRequestDetails":{
            "workRequestEntityType":"coreservicesworkrequest",
            "workRequestGetOperationId":"GetWorkRequest",
            "successfulLifecycleStates":[
                "ACTIVE"
            ],
            "failedLifecycleStates":[
                "FAILED"
            ]
        }
    },
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "lifecycleState",
        "timeCreated",
        "ipAddresses",
        "subnetId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the network load balancer."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment containing the network load balancer."
        },
        "displayName":{
            "type":"string",
            "description":"A user-friendly name, which does not need to be unique, and can be changed."
        },
        "lifecycleState":{
            "description":"The current state of the network load balancer.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/LifecycleState",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "nlbIpVersion":{
            "description":"IP version associated with the NLB.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/NlbIpVersion",
            "enum":[
                "IPV4",
                "IPV4_AND_IPV6",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z "
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z ",
            "x-default-description":"This value is the value of the timeCreated parameter, if no other action after create has been taken on the resource."
        },
        "ipAddresses":{
            "type":"array",
            "description":"An array of IP addresses.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/IpAddress"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "default":true,
            "description":"Whether the network load balancer has a virtual cloud network-local (private) IP address. If \"true\", then the service assigns a private IP address to the network load balancer. If \"false\", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending the security list rules for your virtual cloudn network. This value is true by default. Example: true "
        },
        "isPreserveSourceDestination":{
            "type":"boolean",
            "description":"When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.",
            "default":false
        },
        "isSymmetricHashEnabled":{
            "type":"boolean",
            "description":"This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled.  This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT. ",
            "default":false
        },
        "subnetId":{
            "type":"string",
            "description":"The OCID of the subnet in which the network load balancer is spawned.\""
        },
        "networkSecurityGroupIds":{
            "type":"array",
            "maxItems":5,
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "description":"An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: [\"ocid1.nsg.<var>unique_ID</var>\"] "
        },
        "listeners":{
            "type":"object",
            "description":"Listeners associated with the network load balancer.",
            "additionalProperties":{
                "$ref":"#/definitions/Listener"
            }
        },
        "backendSets":{
            "type":"object",
            "description":"Backend sets associated with the network load balancer.",
            "additionalProperties":{
                "$ref":"#/definitions/BackendSet"
            }
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the string type is supported. "
                }
            }
        },
        "systemTags":{
            "type":"object",
            "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
            "additionalProperties":{
                "type":"object",
                "description":"The value of the tag. Only string, integer and boolean types are supported. ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported. "
                }
            }
        }
    },
    "description":"The properties that define a network load balancer. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator.",
    "x-example":"{   \"id\": \"ocid1.networkloadbalancer.oc1.phx.<var>&lt;unique_ID&gt;</var>\",   \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",   \"displayName\": \"example_network_load_balancer\",   \"lifecycleState\": \"ACTIVE\",   \"timeCreated\": \"2020-05-01T21:10:29.600Z\",   \"isPrivate\": true,   \"isPreserveSourceDestination\": false,   \"isSymmetricHashEnabled\": false,   \"ipAddress\": \"192.168.0.3\",   \"listeners\": {     \"exampleListener\": {       \"defaultBackendSetName\": \"example_backend_set\",       \"port\": 80,       \"protocol\": \"HTTP\",     },   },   \"backendSets\": {     \"example_backend_set\": {       \"policy\": \"FIVE_TUPLE\",       \"backends\": [         {           \"ipAddress\": \"10.0.0.3\",           \"port\": 8080,           \"backup\": false,           \"drain\": false,           \"offline\": false         },         {           \"ipAddress\": \"10.0.0.4\",           \"port\": 8080,           \"backup\": false,           \"drain\": false,           \"offline\": false         }       ],       \"healthChecker\": {         \"protocol\": \"HTTP\",         \"port\": 8080,         \"timeoutInMillis\": 3000,         \"intervalInMillis\": 10000,         \"urlPath\": \"/healthcheck\",         \"returnCode\": 200,         \"retries\": 3,         \"responseBodyRegex\": \"^((?!false).|\\s)*$\"       },     },   },   \"subnetId\": \"ocid1.subnet.oc1.phx.<var>&lt;unique_ID&gt;</var>\", } "
}

Nested Schema : backendSets

Type: object

Additional Properties Allowed

Show Source

• object BackendSet
  The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.

{
    "type":"object",
    "description":"Backend sets associated with the network load balancer.",
    "additionalProperties":{
        "$ref":"#/definitions/BackendSet"
    }
}

Backend sets associated with the network load balancer.

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the string type is supported. "
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : ipAddresses

Type: array

Unique Items Required: true

An array of IP addresses.

Show Source

• Array of: object IpAddress
  A load balancer IP address.

{
    "type":"array",
    "description":"An array of IP addresses.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/IpAddress"
    }
}

Nested Schema : listeners

Type: object

Additional Properties Allowed

Show Source

• object Listener
  The congfiguration of the listener.

{
    "type":"object",
    "description":"Listeners associated with the network load balancer.",
    "additionalProperties":{
        "$ref":"#/definitions/Listener"
    }
}

Listeners associated with the network load balancer.

Nested Schema : networkSecurityGroupIds

Type: array

Maximum Number of Items: 5

An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "maxItems":5,
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":255
    },
    "description":"An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: [\"ocid1.nsg.<var>unique_ID</var>\"] "
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported. ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported. "
        }
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}

Nested Schema : BackendSet

Type: object

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

Show Source

• backends: array backends
  Unique Items Required: true

  Array of backends.
• healthChecker(required): object HealthChecker
  The health check policy configuration.
• ipVersion: string
  Default Value: IPV4

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

  IP version associated with the backend set.
• isAdAffinityEnabled: boolean
  If this parameter is enabled, the NLB fleet in a particular AD will prefer backends within the same AD while load-balancing traffic.
• isFailOpen: boolean
  Default Value: false

  If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
• isInstantFailoverEnabled: boolean
  If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
• 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.
• minimumHealthyBackendPercentage: integer
  When backends are added without weights, this value will represent the percent of backends that must be healthy within an AD for AD Affinity to be honored. When backends are added with weights, this value will represent the percent of weights that must be healthy within an AD for AD Affinity to be honored. If the percent of healthy backends falls below this threshold, traffic will be distributed across all healthy backends in all ADs. If this percent value is not specified then default will be 80.
• name(required): string
  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: 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",
        "healthChecker"
    ],
    "properties":{
        "name":{
            "type":"string",
            "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",
            "default":"FIVE_TUPLE",
            "x-obmcs-top-level-enum":"#/definitions/NetworkLoadBalancingPolicy",
            "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
        },
        "isFailOpen":{
            "type":"boolean",
            "description":"If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. ",
            "default":false
        },
        "isInstantFailoverEnabled":{
            "type":"boolean",
            "description":"If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. "
        },
        "ipVersion":{
            "description":"IP version associated with the backend set.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "backends":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/definitions/Backend"
            },
            "description":"Array of backends."
        },
        "healthChecker":{
            "$ref":"#/definitions/HealthChecker"
        },
        "isAdAffinityEnabled":{
            "type":"boolean",
            "description":"If this parameter is enabled, the NLB fleet in a particular AD will prefer backends within the same AD while load-balancing traffic."
        },
        "minimumHealthyBackendPercentage":{
            "description":"When backends are added without weights, this value will represent the percent of backends that must be healthy within an AD for AD Affinity to be honored. When backends are added with weights, this value will represent the percent of weights that must be healthy within an AD for AD Affinity to be honored. If the percent of healthy backends falls below this threshold, traffic will be distributed across all healthy backends in all ADs. If this percent value is not specified then default will be 80. ",
            "type":"integer"
        }
    },
    "description":"The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.",
    "x-example":"{   \"name\": \"example_backend_set\",   \"policy\": \"FIVE_TUPLE\",   \"ipVersion\": \"IPV4\",   \"isFailOpen\": true,   \"isInstantFailoverEnabled\": false,   \"backends\": [     {       \"ipAddress\": \"10.0.0.3\",       \"port\": 8080,       \"isBackup\": false,       \"isDrain\": false,       \"isOffline\": false     },     {       \"id\": \"ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>\",       \"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

Array of backends.

Show Source

• Array of: object Backend
  The configuration of a backend server that is a member of a network load balancer backend set.

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/definitions/Backend"
    },
    "description":"Array of backends."
}

Nested 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 : Backend

Type: object

The configuration of a backend server that is a member of a network load balancer backend set.

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 Backend 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/IP OCID and port that uniquely identify this backend server in the backend set. Examples: 10.0.0.3:8080 or ocid1.privateip..unique_ID:443 or 10.0.0.3:0
• port(required): integer(int32)
  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)
  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.

{
    "type":"object",
    "required":[
        "port"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Examples: 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 Backend 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",
            "description":"The communication port for the backend server. Example: 8080 "
        },
        "weight":{
            "type":"integer",
            "format":"int32",
            "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."
        },
        "isDrain":{
            "type":"boolean",
            "default":false,
            "description":"Whether the network load balancer should drain this server. Servers marked isDrain receive no incoming traffic. Example: false "
        },
        "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 "
        },
        "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 configuration of a backend server that is a member of a network load balancer backend set.",
    "x-example":"{   \"name\": \"example_backend\",   \"ipAddress\": \"10.0.0.3\",   \"port\": 8080,   \"isBackup\": false,   \"isDrain\": false,   \"isOffline\": false } "
}

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

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the string type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the string type is supported. "
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the string type is supported.

Nested Schema : IpAddress

Type: object

A load balancer IP address.

Show Source

• ipAddress(required): string
  An IP address. Example: 192.168.0.3
• ipVersion: string
  Default Value: IPV4

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

  IP version associated with this IP address.
• isPublic: boolean
  Whether the IP address is public or private. If true, then the IP address is public and accessible from the internet. If false, then the IP address is private and accessible only from within the associated virtual cloud network.
• reservedIp: object ReservedIP
  An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

{
    "properties":{
        "ipAddress":{
            "type":"string",
            "description":"An IP address. Example: 192.168.0.3 "
        },
        "isPublic":{
            "type":"boolean",
            "description":"Whether the IP address is public or private. If true, then the IP address is public and accessible from the internet. If false, then the IP address is private and accessible only from within the associated virtual cloud network."
        },
        "ipVersion":{
            "description":"IP version associated with this IP address.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "reservedIp":{
            "$ref":"#/definitions/ReservedIP"
        }
    },
    "required":[
        "ipAddress"
    ],
    "description":"A load balancer IP address.",
    "x-example":"{   \"ipAddress\": \"192.168.0.3\",   \"isPublic\": false } ",
    "type":"object"
}

Nested Schema : ReservedIP

Type: object

An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

Show Source

• id: string
  OCID of the reserved public IP address created with the virtual cloud network. Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API. Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address. Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer. Example: "ocid1.publicip.unique_ID"

{
    "x-obmcs-splat":{
        "resourceKind":"public-ip",
        "adLocality":"regional1"
    },
    "type":"object",
    "description":"An object representing a reserved IP address to be attached or that is already attached to a network load balancer.",
    "properties":{
        "id":{
            "type":"string",
            "description":"OCID of the reserved public IP address created with the virtual cloud network. Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API. Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address. Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer. Example: \"ocid1.publicip.<var>unique_ID</var>\" "
        }
    }
}

Nested Schema : Listener

Type: object

The congfiguration of the listener.

Show Source

• defaultBackendSetName(required): string
  The name of the associated backend set.
• internalProxyProtocolOptions: array internalProxyProtocolOptions
  Unique Items Required: true

  An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["VCN_ID"]
• ipVersion: string
  Default Value: IPV4

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

  IP version associated with the listener.
• isApplicationOffloadEnabled: boolean
  Default Value: false

  Property to enable/disable Application Offload feature for the NLB. If enabled, NLB will use listener port to forward the packet to application's backends.
• isPpv2Enabled: boolean
  Default Value: false

  Property to enable/disable PPv2 feature for this listener.
• isSgwNatIpTlvTypeOverrideEnabled: boolean
  Default Value: false

  Override to use 0xE1 custom TLV for encoding Class E IP Address in IP Options. (Default is 0xE2)
• name(required): string
  A friendly name for the listener. It must be unique and it cannot be changed.
• port(required): integer(int32)
  The communication port for the listener. Example: 80

  Example: 0
• protocol(required): string
  Allowed Values: [ "ANY", "TCP", "UDP", "TCP_AND_UDP" ]

  The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP
• tcpIdleTimeout: integer(int32)
  The duration for TCP idle timeout Example: `200`
• udpIdleTimeout: integer(int32)
  The duration for UDP idle timeout Example: `200`

{
    "type":"object",
    "required":[
        "name",
        "defaultBackendSetName",
        "port",
        "protocol"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"A friendly name for the listener. It must be unique and it cannot be changed."
        },
        "defaultBackendSetName":{
            "type":"string",
            "description":"The name of the associated backend set."
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "example":0,
            "description":"The communication port for the listener. Example: 80 "
        },
        "protocol":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ListenerProtocols",
            "enum":[
                "ANY",
                "TCP",
                "UDP",
                "TCP_AND_UDP"
            ],
            "description":"The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP "
        },
        "ipVersion":{
            "description":"IP version associated with the listener.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "isPpv2Enabled":{
            "description":"Property to enable/disable PPv2 feature for this listener.",
            "type":"boolean",
            "default":false
        },
        "internalProxyProtocolOptions":{
            "type":"array",
            "uniqueItems":true,
            "description":"An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: [\"VCN_ID\"] ",
            "items":{
                "$ref":"#/definitions/MetadataOptions"
            }
        },
        "isSgwNatIpTlvTypeOverrideEnabled":{
            "description":"Override to use 0xE1 custom TLV for encoding Class E IP Address in IP Options. (Default is 0xE2)",
            "type":"boolean",
            "default":false
        },
        "tcpIdleTimeout":{
            "type":"integer",
            "format":"int32",
            "description":"The duration for TCP idle timeout Example: `200` "
        },
        "udpIdleTimeout":{
            "type":"integer",
            "format":"int32",
            "description":"The duration for UDP idle timeout Example: `200` "
        },
        "isApplicationOffloadEnabled":{
            "description":"Property to enable/disable Application Offload feature for the NLB. If enabled, NLB will use listener port to forward the packet to application's backends. ",
            "type":"boolean",
            "default":false
        }
    },
    "description":"The congfiguration of the listener.",
    "x-example":"{   \"defaultBackendSetName\": \"example_backend_set\",   \"port\": 80,   \"protocol\": \"TCP\",   \"name\": \"example_listener\" } "
}

Nested Schema : internalProxyProtocolOptions

Type: array

Unique Items Required: true

An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["VCN_ID"]

Show Source

• Array of: string
  Allowed Values: [ "VCN_ID", "SGW_PE_NAT_IP", "VCN_OCID", "PE_OCID", "SGW_OCID" ]

  TLV type for the PPv2 feature.

{
    "type":"array",
    "uniqueItems":true,
    "description":"An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: [\"VCN_ID\"] ",
    "items":{
        "$ref":"#/definitions/MetadataOptions"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"The value of the tag. Only string, integer and boolean types are supported. ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported. "
    }
}

The value of the tag. Only string, integer and boolean types are supported.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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. 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 must contact Oracle about a particular request, then provide the request identifier.

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

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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

Back to Top