The configuration details for creating a load balancer.
Root Schema : CreateLoadBalancerDetails
Type: object
The configuration details for creating a load balancer. Avoid entering confidential information when you supply string values using the API.
Show Source
-
backendSets:
object backendSets
-
certificates:
object certificates
-
cidrBlocks:
object cidrBlocks
-
compartmentId(required):
string
Minimum Length: 1
Maximum Length: 255
The OCID of the compartment in which to create the load balancer.
-
definedTags:
object definedTags
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
displayName(required):
string
Minimum Length: 1
Maximum Length: 1024
A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.
-
freeformTags:
object freeformTags
Free-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
-
ipMode:
string
Default Value: IPV4
Allowed Values: [
"IPV4",
"IPV6"
]
Whether the load balancer has an IPv4 or IPv6 IP address. If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. Example: "ipMode": "IPV6"
-
isPrivate:
boolean
Default Value: false
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
-
listeners:
object listeners
-
networkSecurityGroupIds:
array networkSecurityGroupIds
Minimum Number of Items: 0
Maximum Number of Items: 5
An array of NSG OCIDs associated with this load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of using NSGs with the load balancer 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
-
reservedIps:
array reservedIps
Minimum Number of Items: 0
Maximum Number of Items: 1
An array of reserved Ips.
-
ruleSets:
object ruleSets
-
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
-
subnetIds(required):
array subnetIds
An array of subnet OCIDs.
-
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.
{
"type":"object",
"required":[
"compartmentId",
"displayName",
"shapeName",
"subnetIds"
],
"properties":{
"compartmentId":{
"type":"string",
"minLength":"1",
"maxLength":"255",
"description":"The OCID of the compartment in which to create the load balancer."
},
"displayName":{
"type":"string",
"minLength":"1",
"maxLength":"1024",
"description":"A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information."
},
"shapeName":{
"type":"string",
"description":"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 "
},
"shapeDetails":{
"$ref":"#/definitions/ShapeDetails",
"description":"The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible."
},
"isPrivate":{
"type":"boolean",
"description":"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 ",
"default":false
},
"wafPolicyId":{
"minLength":"0",
"maxLength":"256",
"type":"string",
"description":"WAF policy OCID, which is attached to the specified Load Balancer. Can be empty, which means that WAF policy is not attached."
},
"ipMode":{
"type":"string",
"description":"Whether the load balancer has an IPv4 or IPv6 IP address. If \"IPV4\", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. If \"IPV6\", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. Example: \"ipMode\": \"IPV6\" ",
"enum":[
"IPV4",
"IPV6"
],
"default":"IPV4"
},
"reservedIps":{
"type":"array",
"description":"An array of reserved Ips.",
"minItems":"0",
"maxItems":"1",
"items":{
"$ref":"#/definitions/ReservedIP"
}
},
"listeners":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/ListenerDetails"
}
},
"hostnames":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/HostnameDetails"
}
},
"backendSets":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/BackendSetDetails"
}
},
"networkSecurityGroupIds":{
"type":"array",
"minItems":"0",
"maxItems":"5",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"256",
"description":"The OCID of a network security group (NSG) to add this load balancer to."
},
"description":"An array of NSG OCIDs associated with this load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of using NSGs with the load balancer 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.<var>unique_ID</var>\"] "
},
"subnetIds":{
"type":"array",
"description":"An array of subnet OCIDs.",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
},
"certificates":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/CertificateDetails"
}
},
"cidrBlocks":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/CidrBlocksDetails"
}
},
"sslCipherSuites":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/SSLCipherSuiteDetails"
}
},
"pathRouteSets":{
"deprecated":true,
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/PathRouteSetDetails"
}
},
"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."
}
}
},
"ruleSets":{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/RuleSetDetails"
}
}
},
"description":"The configuration details for creating a load balancer. Avoid entering confidential information when you supply string values using the API.",
"x-example":"{ \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\", \"displayName\": \"example_load_balancer\", \"shapeName\": \"Flexible\", \"shapeDetails\": { \"minimumBandwidthInMbps\": 100, \"maximumBandwidthInMbps\": 1000 } \"isPrivate\": true, \"ipMode\": \"IPV6\", \"reservedIps\":[{ \"id\": \"ocid1.floatingip.<var>unique_ID</var>\" }] \"listeners\": { \"exampleListener\": { \"defaultBackendSetName\": \"example_backend_set\", \"port\": 80, \"protocol\": \"HTTP\", \"pathRouteSetName\": \"example_path_route_set\", \"sslConfiguration\": { \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"], \"cipherSuiteName\": \"example_cipher_suite\", \"serverOrderPreference\": \"ENABLED\", \"certificateName\": \"example_certificate_bundle\", \"verifyPeerCertificate\": true, \"verifyDepth\": 3 }, \"connectionConfiguration\": { \"idleTimeout\": 1200 } } }, \"hostnames\": { \"example_hostname_001: { \"name\": \"example_hostname_001\", \"hostname\": \"app.example.com\" }, \"example_hostname_002: { \"name\": \"example_hostname_002\", \"hostname\": \"app.example.*\" } } \"backendSets\": { \"example_backend_set\": { \"policy\": \"LEAST_CONNECTIONS\", \"backends\": [ { \"ipAddress\": \"10.0.0.3\", \"port\": 8080, \"weight\": 3, \"backup\": false, \"drain\": false, \"offline\": false }, { \"ipAddress\": \"10.0.0.4\", \"port\": 8080, \"weight\": 1, \"backup\": false, \"drain\": false, \"offline\": false } ], \"healthChecker\": { \"protocol\": \"HTTP\", \"urlPath\": \"/healthcheck\", \"port\": 8080, \"returnCode\": 200, \"retries\": 3, \"timeoutInMillis\": 3000, \"intervalInMillis\": 10000, \"responseBodyRegex\": \"^((?!false).|\\s)*$\" }, \"sslConfiguration\": { \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"], \"cipherSuiteName\": \"example_cipher_suite\", \"serverOrderPreference\": \"ENABLED\", \"certificateName\": \"example_certificate_bundle\", \"verifyPeerCertificate\": true, \"verifyDepth\": 3 }, \"lbCookieSessionPersistenceConfiguration\": { \"cookieName\": \"example_cookie\", \"disableFallback\": false \"domain\": \"example.oracle.com\", \"path\": \"/example\", \"maxAgeInSeconds\": 3600, \"isSecure\": true, \"isHttpOnly\": true } }, }, \"cidrBlocks\": { \"ExampleCidrBlocks\":{ \"items\": [ \"129.213.176.0/24\", \"150.136.187.0/24\", \"2002::1234:abcd:ffff:c0a8:101/64\" ], \"name\": \"ExampleCidrBlocks\" } }, \"sslCipherSuites\": { \"example_cipher_suite\": { \"ciphers\": [ \"ECDHE-ECDSA-AES128-GCM-SHA256\", \"ECDHE-ECDSA-AES128-SHA256\", \"ECDHE-RSA-AES128-GCM-SHA256\" ], \"name\": \"example_cipher_suite\" } }, \"certificates\": { \"example_certificate_bundle\": { \"passphrase\": \"<var>passphrase></var>\", \"privateKey\": \"<var>private_key></var>\", \"publicCertificate\": \"<var>public_certificate></var>\", \"caCertificate\": \"<var>ca_certificate></var>\", \"certificateName\": \"example_certificate_bundle\" } }, \"pathRouteSets\": { \"example_path_route_set\": { \"pathRoutes\": [ { \"path\": \"/example/video/123\", \"pathMatchType\": { \"matchType\": \"EXACT_MATCH\" }, \"backendSetName\": \"example_backend_set\" } ] } }, \"ruleSets\": { \"example_rule_set\": { \"items\": [ { \"action\": \"ADD_REQUEST_HEADER\", \"header\": \"example_header_name\", \"value\": \"example_value\" }, { \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\", \"header\": \"example_header_name2\", \"prefix\": \"example_prefix_value\", \"suffix\": \"example_suffix_value\" } ] } } }, \"networkSecurityGroupIds\": [ \"ocid1.nsg.<var>unique_ID</var>\" ], \"subnetIds\": [ \"ocid1.subnet.<var>unique_ID</var>\" ] } "
}
Nested Schema : backendSets
Type: object
Additional Properties Allowed
Show Source
-
object BackendSetDetails
The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/BackendSetDetails"
}
}
Nested Schema : certificates
Type: object
Additional Properties Allowed
Show Source
-
object CertificateDetails
The configuration details for a certificate bundle. Avoid entering confidential information when you supply string values using the API.
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/CertificateDetails"
}
}
Nested Schema : cidrBlocks
Type: object
Additional Properties Allowed
Show Source
-
object CidrBlocksDetails
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"] Avoid entering confidential information in this API.
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/CidrBlocksDetails"
}
}
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
-
object 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
{
"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 : hostnames
Type: object
Additional Properties Allowed
Show Source
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/HostnameDetails"
}
}
Nested Schema : listeners
Type: object
Additional Properties Allowed
Show Source
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/ListenerDetails"
}
}
Nested Schema : networkSecurityGroupIds
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 5
An array of NSG OCIDs associated with this load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of using NSGs with the load balancer 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
The OCID of a network security group (NSG) to add this load balancer to.
{
"type":"array",
"minItems":"0",
"maxItems":"5",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"256",
"description":"The OCID of a network security group (NSG) to add this load balancer to."
},
"description":"An array of NSG OCIDs associated with this load balancer. During the load balancer's creation, the service adds the new load balancer to the specified NSGs. The benefits of using NSGs with the load balancer 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.<var>unique_ID</var>\"] "
}
Nested Schema : pathRouteSets
Type: object
Additional Properties Allowed
Show Source
{
"deprecated":true,
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/PathRouteSetDetails"
}
}
Nested Schema : reservedIps
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1
An array of reserved Ips.
Show Source
-
Array of:
object ReservedIP
An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
{
"type":"array",
"description":"An array of reserved Ips.",
"minItems":"0",
"maxItems":"1",
"items":{
"$ref":"#/definitions/ReservedIP"
}
}
Nested Schema : ruleSets
Type: object
Additional Properties Allowed
Show Source
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/RuleSetDetails"
}
}
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
{
"type":"object",
"required":[
"minimumBandwidthInMbps",
"maximumBandwidthInMbps"
],
"properties":{
"minimumBandwidthInMbps":{
"type":"integer",
"format":"int32",
"minimum":"10",
"maximum":"8192",
"description":"Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example: 150 "
},
"maximumBandwidthInMbps":{
"type":"integer",
"format":"int32",
"minimum":"10",
"maximum":"8192",
"description":"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 "
}
},
"description":"The configuration details to update load balancer to a different shape. ",
"x-example":"{ \"minimumBandwidthInMbps\": 150, \"maximumBandwidthInMbps\": 1500 } "
}
Nested Schema : sslCipherSuites
Type: object
Additional Properties Allowed
Show Source
-
object SSLCipherSuiteDetails
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"
{
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/SSLCipherSuiteDetails"
}
}
Nested Schema : subnetIds
Type: array
An array of subnet OCIDs.
Show Source
{
"type":"array",
"description":"An array of subnet OCIDs.",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
}
Nested Schema : BackendSetDetails
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
An 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.
-
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":[
"healthChecker"
],
"properties":{
"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 "
},
"ipVersion":{
"description":"IP version associated with the backend set.",
"type":"string",
"x-obmcs-top-level-enum":"#/definitions/IpVersion",
"enum":[
"IPV4",
"IPV6"
],
"default":"IPV4"
},
"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
},
"backends":{
"type":"array",
"uniqueItems":true,
"items":{
"$ref":"#/definitions/Backend"
},
"description":"An array of backends."
},
"healthChecker":{
"$ref":"#/definitions/HealthChecker"
}
},
"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\", \"backends\": [ { \"ipAddress\": \"10.0.0.3\", \"port\": 8080, \"isBackup\": false, \"isDrain\": false, \"isOffline\": false }, { \"id\": \"ocid1.privateip..<var>unique_ID</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
An 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.
{
"type":"array",
"uniqueItems":true,
"items":{
"$ref":"#/definitions/Backend"
},
"description":"An array of backends."
}
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: 8080
Example: 8080
-
protocol(required):
string
Allowed Values: [
"HTTP",
"HTTPS",
"TCP",
"UDP"
]
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
-
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"
],
"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."
}
},
"description":"The health check policy configuration.",
"x-example":"{ \"protocol\": \"HTTP\", \"port\": 8080, \"timeoutInMillis\": 3000, \"intervalInMillis\": 10000, \"retries\": 3, \"urlPath\": \"/healthcheck\", \"returnCode\": 200, \"responseBodyRegex\": \"^((?!false).|\\s)*$\" } or { \"protocol\": \"UDP\", \"port\": 8080, \"timeoutInMillis\": 3000, \"intervalInMillis\": 10000, \"retries\": 3, \"requestData\": \"4wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\", \"responseData\": \"JA==\" } "
}
Nested Schema : 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 : CertificateDetails
Type: object
The configuration details for a certificate bundle. Avoid entering confidential information when you supply string values using the API.
Show Source
-
caCertificate:
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 user-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.
-
passphrase:
string
A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase.
-
privateKey:
string
The SSL private key for your certificate, in PEM format. Example: -----BEGIN RSA PRIVATE KEY----- jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16 /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ ... -----END RSA PRIVATE KEY-----
-
publicCertificate:
string
The public certificate, in PEM format, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ... -----END CERTIFICATE-----
{
"type":"object",
"required":[
"certificateName"
],
"properties":{
"passphrase":{
"type":"string",
"description":"A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase."
},
"privateKey":{
"type":"string",
"description":"The SSL private key for your certificate, in PEM format. Example: -----BEGIN RSA PRIVATE KEY----- jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16 /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ ... -----END RSA PRIVATE KEY----- "
},
"publicCertificate":{
"type":"string",
"description":"The public certificate, in PEM format, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ... -----END CERTIFICATE----- "
},
"caCertificate":{
"type":"string",
"description":"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":{
"type":"string",
"pattern":"^[a-zA-Z0-9_.-]*$",
"minLength":"1",
"maxLength":"255",
"description":"A user-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."
}
},
"description":"The configuration details for a certificate bundle. Avoid entering confidential information when you supply string values using the API.",
"x-example":"{ \"passphrase\": \"<var>passphrase></var>\", \"privateKey\": \"<var>private_key></var>\", \"publicCertificate\": \"<var>public_certificate></var>\", \"caCertificate\": \"<var>ca_certificate></var>\", \"certificateName\": \"example_certificate_bundle\", } "
}
Nested Schema : CidrBlocksDetails
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"] Avoid entering confidential information 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 user-friendly name for the CidrBlocks.
{
"type":"object",
"required":[
"name",
"items"
],
"properties":{
"items":{
"type":"array",
"minItems":"1",
"items":{
"type":"string"
},
"uniqueItems":true,
"description":"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":{
"type":"string",
"minLength":"1",
"maxLength":"255",
"pattern":"^[a-zA-Z0-9_-]*$",
"description":"A user-friendly name for the CidrBlocks."
}
},
"description":"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\"] Avoid entering confidential information in this API.",
"x-example":"{ \"name\": \"ClientRealIpCidrBlocks\", \"items\": [\"129.213.176.0/24\",\"150.136.187.0/24\"] } "
}
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
{
"type":"array",
"minItems":"1",
"items":{
"type":"string"
},
"uniqueItems":true,
"description":"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\"]' "
}
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
{
"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 : HostnameDetails
Type: object
The details of a hostname resource associated with a load balancer.
Show Source
{
"type":"object",
"required":[
"name",
"hostname"
],
"properties":{
"name":{
"type":"string",
"description":"The name of the hostname resource. Example: example_hostname_001 "
},
"hostname":{
"type":"string",
"description":"A virtual hostname. Example: app.example.com "
}
},
"description":"The details of a hostname resource associated with a load balancer."
}
Nested Schema : ListenerDetails
Type: object
The listener's configuration.
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 user-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
{
"type":"object",
"required":[
"name",
"defaultBackendSetName",
"port",
"protocol"
],
"properties":{
"name":{
"type":"string",
"description":"A user-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."
},
"ipVersion":{
"description":"IP version associated with the listener.",
"type":"string",
"x-obmcs-top-level-enum":"#/definitions/IpVersion",
"enum":[
"IPV4",
"IPV6"
],
"default":"IPV4"
},
"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 "
}
},
"description":"The listener's configuration.",
"x-example":"{ \"defaultBackendSetName\": \"example_backend_set\", \"port\": 80, \"protocol\": \"TCP\", \"name\": \"example_listener\" } "
}
Nested Schema : PathRouteSetDetails
Type: object
A set of path route rules.
Show Source
{
"type":"object",
"description":"A set of path route rules.",
"required":[
"pathRoutes"
],
"properties":{
"pathRoutes":{
"type":"array",
"minItems":"1",
"description":"The set of path route rules.",
"maxItems":"20",
"items":{
"$ref":"#/definitions/PathRoute"
}
}
},
"x-example":"{ \"pathRoutes\": [ { \"path\": \"/example/video/123\", \"pathMatchType\": { \"matchType\": \"EXACT_MATCH\" }, \"backendSetName\": \"example_backend_set\" } ] } "
}
Nested Schema : pathRoutes
Type: array
Minimum Number of Items: 1
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.
{
"type":"array",
"minItems":"1",
"description":"The set of path route rules.",
"maxItems":"20",
"items":{
"$ref":"#/definitions/PathRoute"
}
}
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.
{
"type":"object",
"description":"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.",
"required":[
"path",
"pathMatchType",
"backendSetName"
],
"properties":{
"path":{
"type":"string",
"minLength":"1",
"maxLength":"2048",
"description":"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":{
"description":"The type of matching to apply to incoming URIs.",
"$ref":"#/definitions/PathMatchType"
},
"backendSetName":{
"type":"string",
"minLength":"1",
"maxLength":"32",
"description":"The name of the target backend set for requests where the incoming URI matches the specified path."
}
},
"x-example":"{ \"path\": \"/example/video/123\", \"pathMatchType\": { \"matchType\": \"EXACT_MATCH\" }, \"backendSetName\": \"example_backend_set\" } "
}
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.
{
"type":"object",
"description":"The type of matching to apply to incoming URIs.",
"required":[
"matchType"
],
"properties":{
"matchType":{
"type":"string",
"enum":[
"EXACT_MATCH",
"FORCE_LONGEST_PREFIX_MATCH",
"PREFIX_MATCH",
"SUFFIX_MATCH"
],
"description":"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."
}
},
"x-example":"{ \"matchType\": \"EXACT_MATCH\" } "
}
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 : RuleSetDetails
Type: object
The rules that compose a rule set.
Show Source
{
"type":"object",
"description":"The rules that compose a rule set.",
"required":[
"items"
],
"properties":{
"items":{
"description":"An array of rules that compose the rule set.",
"type":"array",
"items":{
"$ref":"#/definitions/Rule"
}
}
},
"x-example":"{ \"items\": [ { \"action\": \"ADD_REQUEST_HEADER\", \"header\": \"example_header_name\", \"value\": \"example_value\" }, { \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\", \"header\": \"example_header_name2\", \"prefix\": \"example_prefix_value\", \"suffix\": \"example_suffix_value\" } ] } "
}
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.
{
"description":"An array of rules that compose the rule set.",
"type":"array",
"items":{
"$ref":"#/definitions/Rule"
}
}
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"
]
{
"type":"object",
"description":"An object that represents an action to apply to a listener.",
"required":[
"action"
],
"discriminator":"action",
"properties":{
"action":{
"type":"string",
"enum":[
"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"
]
}
},
"x-example":"{ \"action\": \"ADD_HTTP_REQUEST_HEADER\", \"header\": \"example_header_name\", \"value\": \"example_value\" } "
}
Nested Schema : SSLCipherSuiteDetails
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 user-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
{
"type":"object",
"required":[
"name",
"ciphers"
],
"properties":{
"ciphers":{
"type":"array",
"minItems":"1",
"items":{
"type":"string"
},
"description":"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":{
"type":"string",
"minLength":"1",
"maxLength":"255",
"pattern":"^[a-zA-Z0-9_-]*$",
"description":"A user-friendly name for the SSL cipher suite. It must be unique and it cannot be changed.<p>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"
}
},
"description":"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\" ",
"x-example":"{ \"ciphers\": ['ECDHE-RSA-AES256-GCM-SHA384','ECDHE-ECDSA-AES256-GCM-SHA384','ECDHE-RSA-AES128-GCM-SHA256'], \"name\": \"example_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
{
"type":"array",
"minItems":"1",
"items":{
"type":"string"
},
"description":"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\"]' "
}