GetLoadBalancer
get
/20170115/loadBalancers/{load_balancer_id}
Get the specified load balancer's configuration information.
Request
Supported Media Types
- application/json
Path Parameters
-
loadBalancerId(required): string
The OCID of the load balancer to retrieve.
Header Parameters
-
if-none-match: string
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, the system returns the HTTP status code 304 (Not Modified). Example: example-etagDefault 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:
Response
Supported Media Types
- application/json
200 Response
The configuration information is being retrieved.
Headers
-
ETag: string
Identifies the version of the loadbalancer returned.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : LoadBalancer
Type:
object
The properties that define a load balancer.
Show Source
-
backendSets:
object backendSets
Additional Properties Allowed: BackendSet
-
certificates:
object certificates
Additional Properties Allowed: Certificate
-
cidrBlocks:
object cidrBlocks
Additional Properties Allowed: CidrBlocks
-
compartmentId(required):
string
The OCID of the compartment containing the load balancer.
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
displayName(required):
string
A user-friendly name. It does not need to be unique, and it is changeable.
-
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
hostnames:
object hostnames
Additional Properties Allowed: Hostname
-
id(required):
string
The OCID of the load balancer.
-
ipAddresses:
array ipAddresses
Unique Items Required:
true
An array of IP addresses. -
isPrivate:
boolean
Whether the load balancer has a VCN-local (private) IP address. If true, the service assigns a private IP address to the load balancer. If false, the service assigns a public IP address to the load balancer. A public load balancer is accessible from the internet, depending on your VCN's security list rules. Example: true
-
lifecycleState(required):
string
Allowed Values:
[ "CREATING", "FAILED", "ACTIVE", "DELETING", "DELETED" ]
The current state of the load balancer. -
listeners:
object listeners
Additional Properties Allowed: Listener
-
networkSecurityGroupIds:
array networkSecurityGroupIds
Minimum Number of Items:
0
An array of NSG OCIDs associated with the load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of associating the load balancer with NSGs include: - NSGs define network security rules to govern ingress and egress traffic for the load balancer. - The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"] -
pathRouteSets:
object pathRouteSets
Additional Properties Allowed: PathRouteSet
-
routingPolicies:
object routingPolicies
Additional Properties Allowed: RoutingPolicy
-
ruleSets:
object ruleSets
Additional Properties Allowed: RuleSet
-
shapeDetails:
object ShapeDetails
The configuration details to update load balancer to a different shape.
-
shapeName(required):
string
A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example: 100Mbps
-
sslCipherSuites:
object sslCipherSuites
Additional Properties Allowed: SSLCipherSuite
-
subnetIds:
array subnetIds
An array of subnet OCIDs.
-
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesSystem tags for this resource. Each key is predefined and scoped to a namespace. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
-
timeCreated(required):
string(date-time)
The date and time the load balancer was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
-
wafPolicyId:
string
Minimum Length:
0
Maximum Length:256
WAF policy OCID, which is attached to the specified Load Balancer. Can be empty, which means that WAF policy is not attached.
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.
Nested Schema : certificates
Type:
object
Additional Properties Allowed
Show Source
-
object Certificate
The configuration details of a certificate bundle. Avoid entering confidential information when you supply string values using the API.
Nested Schema : cidrBlocks
Type:
object
Additional Properties Allowed
Show Source
-
object CidrBlocks
The configuration details of the CidrBlocks. CidrBlocks contains a name and list of CIDR block. Each of the CidrBlocks should have unique name within the load balancer. CidrBlocks resource name can be used in rule conditions. Example: "name": `ClientRealIpCidrBlocks` "items": `["129.213.176.0/24","150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]` Warning: No confidential information should be passed in this API.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}
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
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.
Nested Schema : networkSecurityGroupIds
Type:
array
Minimum Number of Items:
0
An array of NSG OCIDs associated with the load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of associating the load balancer with NSGs include: - NSGs define network security rules to govern ingress and egress traffic for the load balancer. - The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:256
oracle.doceng.json.BetterJsonNull@15c27b65
Nested Schema : pathRouteSets
Type:
object
Additional Properties Allowed
Show Source
-
object PathRouteSet
A named set of path route rules. Avoid entering confidential information when you supply string values using the API.
Nested Schema : routingPolicies
Type:
object
Additional Properties Allowed
Show Source
-
object RoutingPolicy
A named ordered list of routing rules that is applied to a listener. Avoid entering confidential information when you supply string values using the API.
Nested Schema : ShapeDetails
Type:
object
The configuration details to update load balancer to a different shape.
Show Source
-
maximumBandwidthInMbps(required):
integer(int32)
Minimum Value:
10
Maximum Value:8192
Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter. The values must be between minimumBandwidthInMbps and 8192 (8Gbps). Example: 1500 -
minimumBandwidthInMbps(required):
integer(int32)
Minimum Value:
10
Maximum Value:8192
Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example: 150
Nested Schema : sslCipherSuites
Type:
object
Additional Properties Allowed
Show Source
-
object SSLCipherSuite
The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. Avoid entering confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration. You can create custom cipher suites if the predefined cipher suites do not meet your requirements. * __oci-default-ssl-cipher-suite-v1__ "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __oci-modern-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __oci-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" * __oci-wider-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA"
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"free-tier-retained": "true"}
System tags for this resource. Each key is predefined and scoped to a namespace. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
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. -
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
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
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.
Nested Schema : HealthChecker
Type:
object
The health check policy configuration.
Show Source
-
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: 8080Example:
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. -
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
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.
Nested Schema : Certificate
Type:
object
The configuration details of a certificate bundle. Avoid entering confidential information when you supply string values using the API.
Show Source
-
caCertificate(required):
string
The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy ... -----END CERTIFICATE-----
-
certificateName(required):
string
Minimum Length:
1
Maximum Length:255
Pattern:^[a-zA-Z0-9_.-]*$
A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. -
publicCertificate(required):
string
The public certificate, in PEM format, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ... -----END CERTIFICATE-----
Nested Schema : CidrBlocks
Type:
object
The configuration details of the CidrBlocks. CidrBlocks contains a name and list of CIDR block. Each of the CidrBlocks should have unique name within the load balancer. CidrBlocks resource name can be used in rule conditions. Example: "name": `ClientRealIpCidrBlocks` "items": `["129.213.176.0/24","150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]` Warning: No confidential information should be passed in this API.
Show Source
-
items(required):
array items
Minimum Number of Items:
1
Unique Items Required:true
Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]' -
name(required):
string
Minimum Length:
1
Maximum Length:255
Pattern:^[a-zA-Z0-9_-]*$
A friendly name for the CidrBlocks. Example: SourceIpCidrBlocks
Nested Schema : items
Type:
array
Minimum Number of Items:
1
Unique Items Required:
true
Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
Show Source
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
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 : Hostname
Type:
object
A hostname resource associated with a load balancer for use by one or more listeners. Avoid entering confidential information when you supply string values using the API.
Show Source
-
hostname(required):
string
A virtual hostname. Example: app.example.com
-
name(required):
string
A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information.
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.
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"
Nested Schema : Listener
Type:
object
The congfiguration of the listener.
Show Source
-
defaultBackendSetName(required):
string
The name of the associated backend set.
-
ipVersion:
string
Default Value:
IPV4
Allowed Values:[ "IPV4", "IPV6" ]
IP version associated with the listener. -
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: 80Example:
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
Nested Schema : PathRouteSet
Type:
object
A named set of path route rules. Avoid entering confidential information when you supply string values using the API.
Show Source
-
name(required):
string
Minimum Length:
1
Maximum Length:32
The unique name for this set of path route rules. Avoid entering confidential information. -
pathRoutes(required):
array pathRoutes
Minimum Number of Items:
0
Maximum Number of Items:20
The set of path route rules.
Nested Schema : pathRoutes
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
20
The set of path route rules.
Show Source
-
Array of:
object PathRoute
A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
Nested Schema : PathRoute
Type:
object
A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
Show Source
-
backendSetName(required):
string
Minimum Length:
1
Maximum Length:32
The name of the target backend set for requests where the incoming URI matches the specified path. -
path(required):
string
Minimum Length:
1
Maximum Length:2048
The path string to match against the incoming URI path. Path strings are case-insensitive. Asterisk (*) wildcards are not supported. Regular expressions are not supported. Example: /example/video/123 -
pathMatchType(required):
object PathMatchType
The type of matching to apply to incoming URIs.
Nested Schema : PathMatchType
Type:
object
The type of matching to apply to incoming URIs.
Show Source
-
matchType(required):
string
Allowed Values:
[ "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH" ]
Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI. EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path. FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path. PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path. SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
Nested Schema : RoutingPolicy
Type:
object
A named ordered list of routing rules that is applied to a listener. Avoid entering confidential information when you supply string values using the API.
Show Source
-
conditionLanguageVersion(required):
string
Allowed Values:
[ "V1" ]
The version of the language in which condition of rules are composed. -
name(required):
string
Minimum Length:
1
Maximum Length:32
Pattern:^[a-zA-Z_][a-zA-Z_0-9]*$
The unique name for this list of routing rules. Avoid entering confidential information. -
rules(required):
array rules
Minimum Number of Items:
1
Maximum Number of Items:100
The ordered list of routing rules.
Nested Schema : rules
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
100
The ordered list of routing rules.
Show Source
-
Array of:
object RoutingRule
A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
Nested Schema : RoutingRule
Type:
object
A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
Show Source
-
actions(required):
array actions
Minimum Number of Items:
1
Maximum Number of Items:1
A list of actions to be applied when conditions of the routing rule are met. -
condition(required):
string
Minimum Length:
1
Maximum Length:4096
A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. -
name(required):
string
Minimum Length:
1
Maximum Length:32
Pattern:^[a-zA-Z_][a-zA-Z_0-9]*$
A unique name for the routing policy rule. Avoid entering confidential information.
Nested Schema : actions
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
1
A list of actions to be applied when conditions of the routing rule are met.
Show Source
-
Array of:
object Action
Discriminator:
name
An entity that represents an action to apply for a routing rule.
Nested Schema : Action
Type:
object
Discriminator:
name
An entity that represents an action to apply for a routing rule.
Show Source
-
name(required):
string
Allowed Values:
[ "FORWARD_TO_BACKENDSET" ]
Nested Schema : RuleSet
Type:
object
A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, such as adding, altering, or removing HTTP headers.
Show Source
-
items(required):
array items
An array of rules that compose the rule set.
-
name(required):
string
The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information.
Nested Schema : items
Type:
array
An array of rules that compose the rule set.
Show Source
-
Array of:
object Rule
Discriminator:
action
An object that represents an action to apply to a listener.
Nested Schema : Rule
Type:
object
Discriminator:
action
An object that represents an action to apply to a listener.
Show Source
-
action(required):
string
Allowed Values:
[ "ADD_HTTP_REQUEST_HEADER", "EXTEND_HTTP_REQUEST_HEADER_VALUE", "REMOVE_HTTP_REQUEST_HEADER", "ADD_HTTP_RESPONSE_HEADER", "EXTEND_HTTP_RESPONSE_HEADER_VALUE", "REMOVE_HTTP_RESPONSE_HEADER", "ADD_HTTP_RESPONSE_COOKIES_FLAGS", "ALLOW", "CONTROL_ACCESS_USING_HTTP_METHODS", "REDIRECT", "HTTP_HEADER" ]
Nested Schema : SSLCipherSuite
Type:
object
The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. Avoid entering confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration. You can create custom cipher suites if the predefined cipher suites do not meet your requirements. * __oci-default-ssl-cipher-suite-v1__ "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __oci-modern-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __oci-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" * __oci-wider-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA"
Show Source
-
ciphers(required):
array ciphers
Minimum Number of Items:
1
A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. The following ciphers are valid values for this property: * __TLSv1.2 ciphers__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA256" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA256" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA384" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA384" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __TLSv1 ciphers also supported by TLSv1.2__ "AES128-SHA" "AES256-SHA" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-SHA" "DH-DSS-AES256-SHA" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-SHA" "DH-RSA-AES256-SHA" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-SHA" "DHE-DSS-AES256-SHA" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-SHA" "DHE-RSA-AES256-SHA" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES256-SHA" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]` -
name(required):
string
Minimum Length:
1
Maximum Length:255
Pattern:^[a-zA-Z0-9_-]*$
A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. Note: The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or reserved SSL cipher suite names: * oci-default-ssl-cipher-suite-v1 * oci-modern-ssl-cipher-suite-v1 * oci-compatible-ssl-cipher-suite-v1 * oci-wider-compatible-ssl-cipher-suite-v1 * oci-customized-ssl-cipher-suite
Nested Schema : ciphers
Type:
array
Minimum Number of Items:
1
A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. The following ciphers are valid values for this property: * __TLSv1.2 ciphers__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA256" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA256" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA384" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA384" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" * __TLSv1 ciphers also supported by TLSv1.2__ "AES128-SHA" "AES256-SHA" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-SHA" "DH-DSS-AES256-SHA" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-SHA" "DH-RSA-AES256-SHA" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-SHA" "DHE-DSS-AES256-SHA" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-SHA" "DHE-RSA-AES256-SHA" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES256-SHA" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]`
Show Source
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
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: {"free-tier-retained": "true"}
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. Provide this request OCID if you need to contact Oracle about this request.
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
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.
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
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.
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
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.
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
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.
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