oci-loadbalancer 2.76.1 → 2.77.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client.d.ts +68 -62
- package/lib/client.js +70 -61
- package/lib/client.js.map +1 -1
- package/lib/model/add-http-request-header-rule.d.ts +5 -5
- package/lib/model/add-http-response-header-rule.d.ts +5 -5
- package/lib/model/allow-rule.d.ts +5 -5
- package/lib/model/backend-details.d.ts +8 -8
- package/lib/model/backend-health.d.ts +4 -4
- package/lib/model/backend-set-details.d.ts +2 -2
- package/lib/model/backend-set-health.d.ts +14 -14
- package/lib/model/backend-set.d.ts +3 -3
- package/lib/model/backend.d.ts +9 -9
- package/lib/model/certificate-details.d.ts +1 -1
- package/lib/model/certificate.d.ts +1 -1
- package/lib/model/connection-configuration.d.ts +2 -2
- package/lib/model/control-access-using-http-methods-rule.d.ts +5 -5
- package/lib/model/create-backend-details.d.ts +8 -8
- package/lib/model/create-backend-set-details.d.ts +3 -3
- package/lib/model/create-certificate-details.d.ts +1 -1
- package/lib/model/create-hostname-details.d.ts +2 -2
- package/lib/model/create-listener-details.d.ts +7 -7
- package/lib/model/create-load-balancer-details.d.ts +8 -8
- package/lib/model/create-path-route-set-details.d.ts +1 -1
- package/lib/model/create-routing-policy-details.d.ts +2 -2
- package/lib/model/create-rule-set-details.d.ts +1 -1
- package/lib/model/create-ss-lcipher-suite-details.d.ts +2 -2
- package/lib/model/extend-http-request-header-value-rule.d.ts +8 -8
- package/lib/model/extend-http-response-header-value-rule.d.ts +8 -8
- package/lib/model/forward-to-backend-set.d.ts +1 -1
- package/lib/model/health-check-result.d.ts +2 -2
- package/lib/model/health-checker-details.d.ts +10 -10
- package/lib/model/health-checker.d.ts +10 -10
- package/lib/model/hostname-details.d.ts +2 -2
- package/lib/model/hostname.d.ts +2 -2
- package/lib/model/http-header-rule.d.ts +1 -1
- package/lib/model/ip-address.d.ts +1 -1
- package/lib/model/l-bcookie-session-persistence-configuration-details.d.ts +34 -34
- package/lib/model/listener-details.d.ts +6 -6
- package/lib/model/listener.d.ts +7 -7
- package/lib/model/load-balancer-health-summary.d.ts +7 -7
- package/lib/model/load-balancer-health.d.ts +16 -16
- package/lib/model/load-balancer-shape.d.ts +1 -1
- package/lib/model/load-balancer.d.ts +7 -7
- package/lib/model/path-match-condition.d.ts +6 -6
- package/lib/model/path-match-type.d.ts +6 -6
- package/lib/model/path-route-set.d.ts +1 -1
- package/lib/model/path-route.d.ts +2 -2
- package/lib/model/redirect-rule.d.ts +5 -5
- package/lib/model/redirect-uri.d.ts +43 -43
- package/lib/model/remove-http-request-header-rule.d.ts +2 -2
- package/lib/model/remove-http-response-header-rule.d.ts +2 -2
- package/lib/model/routing-policy.d.ts +2 -2
- package/lib/model/rule-set.d.ts +1 -1
- package/lib/model/s-sl-cipher-suite-details.d.ts +2 -2
- package/lib/model/s-sl-cipher-suite.d.ts +2 -2
- package/lib/model/s-sl-configuration-details.d.ts +17 -17
- package/lib/model/s-sl-configuration.d.ts +17 -17
- package/lib/model/session-persistence-configuration-details.d.ts +7 -7
- package/lib/model/shape-details.d.ts +2 -2
- package/lib/model/source-vcn-id-condition.d.ts +2 -2
- package/lib/model/source-vcn-ip-address-condition.d.ts +1 -1
- package/lib/model/update-backend-details.d.ts +6 -6
- package/lib/model/update-backend-set-details.d.ts +2 -2
- package/lib/model/update-health-checker-details.d.ts +9 -9
- package/lib/model/update-hostname-details.d.ts +1 -1
- package/lib/model/update-listener-details.d.ts +6 -6
- package/lib/model/update-load-balancer-details.d.ts +3 -3
- package/lib/model/update-load-balancer-shape-details.d.ts +2 -2
- package/lib/model/update-routing-policy-details.d.ts +1 -1
- package/lib/model/update-ss-lcipher-suite-details.d.ts +1 -1
- package/lib/model/work-request.d.ts +3 -3
- package/lib/request/change-load-balancer-compartment-request.d.ts +2 -2
- package/lib/request/create-backend-request.d.ts +3 -3
- package/lib/request/create-backend-set-request.d.ts +2 -2
- package/lib/request/create-certificate-request.d.ts +2 -2
- package/lib/request/create-hostname-request.d.ts +2 -2
- package/lib/request/create-listener-request.d.ts +2 -2
- package/lib/request/create-load-balancer-request.d.ts +1 -1
- package/lib/request/create-path-route-set-request.d.ts +2 -2
- package/lib/request/create-routing-policy-request.d.ts +2 -2
- package/lib/request/create-rule-set-request.d.ts +2 -2
- package/lib/request/create-sslcipher-suite-request.d.ts +2 -2
- package/lib/request/delete-backend-request.d.ts +4 -4
- package/lib/request/delete-backend-set-request.d.ts +3 -3
- package/lib/request/delete-certificate-request.d.ts +3 -3
- package/lib/request/delete-hostname-request.d.ts +3 -3
- package/lib/request/delete-listener-request.d.ts +3 -3
- package/lib/request/delete-load-balancer-request.d.ts +2 -2
- package/lib/request/delete-path-route-set-request.d.ts +3 -3
- package/lib/request/delete-routing-policy-request.d.ts +3 -3
- package/lib/request/delete-rule-set-request.d.ts +3 -3
- package/lib/request/delete-sslcipher-suite-request.d.ts +3 -3
- package/lib/request/get-backend-health-request.d.ts +4 -4
- package/lib/request/get-backend-request.d.ts +4 -4
- package/lib/request/get-backend-set-health-request.d.ts +3 -3
- package/lib/request/get-backend-set-request.d.ts +3 -3
- package/lib/request/get-health-checker-request.d.ts +3 -3
- package/lib/request/get-hostname-request.d.ts +3 -3
- package/lib/request/get-load-balancer-health-request.d.ts +2 -2
- package/lib/request/get-load-balancer-request.d.ts +2 -2
- package/lib/request/get-path-route-set-request.d.ts +3 -3
- package/lib/request/get-routing-policy-request.d.ts +3 -3
- package/lib/request/get-rule-set-request.d.ts +3 -3
- package/lib/request/get-sslcipher-suite-request.d.ts +3 -3
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-backend-sets-request.d.ts +2 -2
- package/lib/request/list-backends-request.d.ts +3 -3
- package/lib/request/list-certificates-request.d.ts +2 -2
- package/lib/request/list-hostnames-request.d.ts +2 -2
- package/lib/request/list-listener-rules-request.d.ts +2 -2
- package/lib/request/list-load-balancer-healths-request.d.ts +4 -4
- package/lib/request/list-load-balancers-request.d.ts +10 -10
- package/lib/request/list-path-route-sets-request.d.ts +2 -2
- package/lib/request/list-policies-request.d.ts +4 -4
- package/lib/request/list-protocols-request.d.ts +4 -4
- package/lib/request/list-routing-policies-request.d.ts +5 -5
- package/lib/request/list-rule-sets-request.d.ts +2 -2
- package/lib/request/list-shapes-request.d.ts +4 -4
- package/lib/request/list-sslcipher-suites-request.d.ts +2 -2
- package/lib/request/list-work-requests-request.d.ts +4 -4
- package/lib/request/update-backend-request.d.ts +4 -4
- package/lib/request/update-backend-set-request.d.ts +3 -3
- package/lib/request/update-health-checker-request.d.ts +3 -3
- package/lib/request/update-hostname-request.d.ts +3 -3
- package/lib/request/update-listener-request.d.ts +3 -3
- package/lib/request/update-load-balancer-request.d.ts +2 -2
- package/lib/request/update-load-balancer-shape-request.d.ts +2 -2
- package/lib/request/update-network-security-groups-request.d.ts +2 -2
- package/lib/request/update-path-route-set-request.d.ts +3 -3
- package/lib/request/update-routing-policy-request.d.ts +3 -3
- package/lib/request/update-rule-set-request.d.ts +3 -3
- package/lib/request/update-sslcipher-suite-request.d.ts +3 -3
- package/lib/response/get-backend-health-response.d.ts +1 -1
- package/lib/response/get-backend-response.d.ts +1 -1
- package/lib/response/get-backend-set-health-response.d.ts +1 -1
- package/lib/response/get-backend-set-response.d.ts +1 -1
- package/lib/response/get-health-checker-response.d.ts +1 -1
- package/lib/response/get-hostname-response.d.ts +1 -1
- package/lib/response/get-load-balancer-health-response.d.ts +1 -1
- package/lib/response/get-load-balancer-response.d.ts +1 -1
- package/lib/response/get-path-route-set-response.d.ts +1 -1
- package/lib/response/get-routing-policy-response.d.ts +1 -1
- package/lib/response/get-rule-set-response.d.ts +1 -1
- package/lib/response/get-sslcipher-suite-response.d.ts +1 -1
- package/lib/response/list-backend-sets-response.d.ts +1 -1
- package/lib/response/list-backends-response.d.ts +1 -1
- package/lib/response/list-certificates-response.d.ts +1 -1
- package/lib/response/list-hostnames-response.d.ts +1 -1
- package/lib/response/list-listener-rules-response.d.ts +1 -1
- package/lib/response/list-path-route-sets-response.d.ts +1 -1
- package/lib/response/list-routing-policies-response.d.ts +1 -1
- package/lib/response/list-rule-sets-response.d.ts +1 -1
- package/lib/response/list-sslcipher-suites-response.d.ts +1 -1
- package/package.json +3 -3
|
@@ -25,7 +25,7 @@ This rule adds a prefix, a suffix, or both to the header value.
|
|
|
25
25
|
* The system does not support this rule for headers with multiple values.
|
|
26
26
|
* <p>
|
|
27
27
|
* The system does not distinquish between underscore and dash characters in headers. That is, it treats
|
|
28
|
-
*
|
|
28
|
+
* {@code example_header_name} and {@code example-header-name} as identical. If two such headers appear in a request, the system
|
|
29
29
|
* applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle
|
|
30
30
|
* recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
|
|
31
31
|
*
|
|
@@ -34,27 +34,27 @@ export interface ExtendHttpRequestHeaderValueRule extends model.Rule {
|
|
|
34
34
|
/**
|
|
35
35
|
* A header name that conforms to RFC 7230.
|
|
36
36
|
* <p>
|
|
37
|
-
Example:
|
|
37
|
+
Example: {@code example_header_name}
|
|
38
38
|
*
|
|
39
39
|
*/
|
|
40
40
|
"header": string;
|
|
41
41
|
/**
|
|
42
42
|
* A string to prepend to the header value. The resulting header value must conform to RFC 7230.
|
|
43
43
|
* With the following exceptions:
|
|
44
|
-
* * value cannot contain
|
|
45
|
-
* * value cannot contain patterns like
|
|
44
|
+
* * value cannot contain {@code $}
|
|
45
|
+
* * value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.
|
|
46
46
|
* <p>
|
|
47
|
-
Example:
|
|
47
|
+
Example: {@code example_prefix_value}
|
|
48
48
|
*
|
|
49
49
|
*/
|
|
50
50
|
"prefix"?: string;
|
|
51
51
|
/**
|
|
52
52
|
* A string to append to the header value. The resulting header value must conform to RFC 7230.
|
|
53
53
|
* With the following exceptions:
|
|
54
|
-
* * value cannot contain
|
|
55
|
-
* * value cannot contain patterns like
|
|
54
|
+
* * value cannot contain {@code $}
|
|
55
|
+
* * value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.
|
|
56
56
|
* <p>
|
|
57
|
-
Example:
|
|
57
|
+
Example: {@code example_suffix_value}
|
|
58
58
|
*
|
|
59
59
|
*/
|
|
60
60
|
"suffix"?: string;
|
|
@@ -25,7 +25,7 @@ This rule adds a prefix, a suffix, or both to the header value.
|
|
|
25
25
|
* The system does not support this rule for headers with multiple values.
|
|
26
26
|
* <p>
|
|
27
27
|
* The system does not distinquish between underscore and dash characters in headers. That is, it treats
|
|
28
|
-
*
|
|
28
|
+
* {@code example_header_name} and {@code example-header-name} as identical. If two such headers appear in a request, the system
|
|
29
29
|
* applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle
|
|
30
30
|
* recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
|
|
31
31
|
*
|
|
@@ -34,27 +34,27 @@ export interface ExtendHttpResponseHeaderValueRule extends model.Rule {
|
|
|
34
34
|
/**
|
|
35
35
|
* A header name that conforms to RFC 7230.
|
|
36
36
|
* <p>
|
|
37
|
-
Example:
|
|
37
|
+
Example: {@code example_header_name}
|
|
38
38
|
*
|
|
39
39
|
*/
|
|
40
40
|
"header": string;
|
|
41
41
|
/**
|
|
42
42
|
* A string to prepend to the header value. The resulting header value must still conform to RFC 7230.
|
|
43
43
|
* With the following exceptions:
|
|
44
|
-
* * value cannot contain
|
|
45
|
-
* * value cannot contain patterns like
|
|
44
|
+
* * value cannot contain {@code $}
|
|
45
|
+
* * value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.
|
|
46
46
|
* <p>
|
|
47
|
-
Example:
|
|
47
|
+
Example: {@code example_prefix_value}
|
|
48
48
|
*
|
|
49
49
|
*/
|
|
50
50
|
"prefix"?: string;
|
|
51
51
|
/**
|
|
52
52
|
* A string to append to the header value. The resulting header value must still conform to RFC 7230.
|
|
53
53
|
* With the following exceptions:
|
|
54
|
-
* * value cannot contain
|
|
55
|
-
* * value cannot contain patterns like
|
|
54
|
+
* * value cannot contain {@code $}
|
|
55
|
+
* * value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.
|
|
56
56
|
* <p>
|
|
57
|
-
Example:
|
|
57
|
+
Example: {@code example_suffix_value}
|
|
58
58
|
*
|
|
59
59
|
*/
|
|
60
60
|
"suffix"?: string;
|
|
@@ -21,7 +21,7 @@ export interface ForwardToBackendSet extends model.Action {
|
|
|
21
21
|
/**
|
|
22
22
|
* Name of the backend set the listener will forward the traffic to.
|
|
23
23
|
* <p>
|
|
24
|
-
Example:
|
|
24
|
+
Example: {@code backendSetForImages}
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
"backendSetName": string;
|
|
@@ -26,14 +26,14 @@ export interface HealthCheckResult {
|
|
|
26
26
|
* The IP address of the health check status report provider. This identifier helps you differentiate same-subnet
|
|
27
27
|
* load balancers that report health check status.
|
|
28
28
|
* <p>
|
|
29
|
-
Example:
|
|
29
|
+
Example: {@code 10.0.0.7}
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
"sourceIpAddress": string;
|
|
33
33
|
/**
|
|
34
34
|
* The date and time the data was retrieved, in the format defined by RFC3339.
|
|
35
35
|
* <p>
|
|
36
|
-
Example:
|
|
36
|
+
Example: {@code 2017-06-02T18:28:11+00:00}
|
|
37
37
|
*
|
|
38
38
|
*/
|
|
39
39
|
"timestamp": Date;
|
|
@@ -19,29 +19,29 @@ export interface HealthCheckerDetails {
|
|
|
19
19
|
/**
|
|
20
20
|
* The protocol the health check must use; either HTTP or TCP.
|
|
21
21
|
* <p>
|
|
22
|
-
Example:
|
|
22
|
+
Example: {@code HTTP}
|
|
23
23
|
*
|
|
24
24
|
*/
|
|
25
25
|
"protocol": string;
|
|
26
26
|
/**
|
|
27
27
|
* The path against which to run the health check.
|
|
28
28
|
* <p>
|
|
29
|
-
Example:
|
|
29
|
+
Example: {@code /healthcheck}
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
"urlPath"?: string;
|
|
33
33
|
/**
|
|
34
34
|
* The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
|
|
35
|
-
* port information from the
|
|
35
|
+
* port information from the {@code Backend} object.
|
|
36
36
|
* <p>
|
|
37
|
-
Example:
|
|
37
|
+
Example: {@code 8080}
|
|
38
38
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
39
39
|
*/
|
|
40
40
|
"port"?: number;
|
|
41
41
|
/**
|
|
42
42
|
* The status code a healthy backend server should return.
|
|
43
43
|
* <p>
|
|
44
|
-
Example:
|
|
44
|
+
Example: {@code 200}
|
|
45
45
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
46
46
|
*/
|
|
47
47
|
"returnCode"?: number;
|
|
@@ -49,7 +49,7 @@ export interface HealthCheckerDetails {
|
|
|
49
49
|
* The number of retries to attempt before a backend server is considered \"unhealthy\". This number also applies
|
|
50
50
|
* when recovering a server to the \"healthy\" state.
|
|
51
51
|
* <p>
|
|
52
|
-
Example:
|
|
52
|
+
Example: {@code 3}
|
|
53
53
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
54
54
|
*/
|
|
55
55
|
"retries"?: number;
|
|
@@ -57,21 +57,21 @@ export interface HealthCheckerDetails {
|
|
|
57
57
|
* The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
|
|
58
58
|
* returns within this timeout period.
|
|
59
59
|
* <p>
|
|
60
|
-
Example:
|
|
60
|
+
Example: {@code 3000}
|
|
61
61
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
62
62
|
*/
|
|
63
63
|
"timeoutInMillis"?: number;
|
|
64
64
|
/**
|
|
65
65
|
* The interval between health checks, in milliseconds.
|
|
66
66
|
* <p>
|
|
67
|
-
Example:
|
|
67
|
+
Example: {@code 10000}
|
|
68
68
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
69
69
|
*/
|
|
70
70
|
"intervalInMillis"?: number;
|
|
71
71
|
/**
|
|
72
72
|
* A regular expression for parsing the response body from the backend server.
|
|
73
73
|
* <p>
|
|
74
|
-
Example:
|
|
74
|
+
Example: {@code ^((?!false).|\\s)*$}
|
|
75
75
|
*
|
|
76
76
|
*/
|
|
77
77
|
"responseBodyRegex"?: string;
|
|
@@ -85,7 +85,7 @@ export interface HealthCheckerDetails {
|
|
|
85
85
|
If \"false\", health checks will be done using SSL encryption if the associated backend set is configured
|
|
86
86
|
* to use SSL. If the backend set is not so configured the health checks will be done using plain text.
|
|
87
87
|
* <p>
|
|
88
|
-
Example:
|
|
88
|
+
Example: {@code false}
|
|
89
89
|
*
|
|
90
90
|
*/
|
|
91
91
|
"isForcePlainText"?: boolean;
|
|
@@ -21,22 +21,22 @@ export interface HealthChecker {
|
|
|
21
21
|
/**
|
|
22
22
|
* The protocol the health check must use; either HTTP or TCP.
|
|
23
23
|
* <p>
|
|
24
|
-
Example:
|
|
24
|
+
Example: {@code HTTP}
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
"protocol": string;
|
|
28
28
|
/**
|
|
29
29
|
* The path against which to run the health check.
|
|
30
30
|
* <p>
|
|
31
|
-
Example:
|
|
31
|
+
Example: {@code /healthcheck}
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
34
|
"urlPath"?: string;
|
|
35
35
|
/**
|
|
36
36
|
* The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
|
|
37
|
-
* port information from the
|
|
37
|
+
* port information from the {@code Backend} object.
|
|
38
38
|
* <p>
|
|
39
|
-
Example:
|
|
39
|
+
Example: {@code 8080}
|
|
40
40
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
41
41
|
*/
|
|
42
42
|
"port": number;
|
|
@@ -44,7 +44,7 @@ export interface HealthChecker {
|
|
|
44
44
|
* The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
|
|
45
45
|
* you can use common HTTP status codes such as \"200\".
|
|
46
46
|
* <p>
|
|
47
|
-
Example:
|
|
47
|
+
Example: {@code 200}
|
|
48
48
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
49
49
|
*/
|
|
50
50
|
"returnCode": number;
|
|
@@ -52,7 +52,7 @@ export interface HealthChecker {
|
|
|
52
52
|
* The number of retries to attempt before a backend server is considered \"unhealthy\". This number also applies
|
|
53
53
|
* when recovering a server to the \"healthy\" state. Defaults to 3.
|
|
54
54
|
* <p>
|
|
55
|
-
Example:
|
|
55
|
+
Example: {@code 3}
|
|
56
56
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
57
57
|
*/
|
|
58
58
|
"retries"?: number;
|
|
@@ -60,21 +60,21 @@ export interface HealthChecker {
|
|
|
60
60
|
* The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
|
|
61
61
|
* returns within this timeout period. Defaults to 3000 (3 seconds).
|
|
62
62
|
* <p>
|
|
63
|
-
Example:
|
|
63
|
+
Example: {@code 3000}
|
|
64
64
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
65
65
|
*/
|
|
66
66
|
"timeoutInMillis"?: number;
|
|
67
67
|
/**
|
|
68
68
|
* The interval between health checks, in milliseconds. The default is 10000 (10 seconds).
|
|
69
69
|
* <p>
|
|
70
|
-
Example:
|
|
70
|
+
Example: {@code 10000}
|
|
71
71
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
72
72
|
*/
|
|
73
73
|
"intervalInMillis"?: number;
|
|
74
74
|
/**
|
|
75
75
|
* A regular expression for parsing the response body from the backend server.
|
|
76
76
|
* <p>
|
|
77
|
-
Example:
|
|
77
|
+
Example: {@code ^((?!false).|\\s)*$}
|
|
78
78
|
*
|
|
79
79
|
*/
|
|
80
80
|
"responseBodyRegex": string;
|
|
@@ -88,7 +88,7 @@ export interface HealthChecker {
|
|
|
88
88
|
If \"false\", health checks will be done using SSL encryption if the associated backend set is configured
|
|
89
89
|
* to use SSL. If the backend set is not so configured the health checks will be done using plain text.
|
|
90
90
|
* <p>
|
|
91
|
-
Example:
|
|
91
|
+
Example: {@code false}
|
|
92
92
|
*
|
|
93
93
|
*/
|
|
94
94
|
"isForcePlainText"?: boolean;
|
|
@@ -19,7 +19,7 @@ export interface HostnameDetails {
|
|
|
19
19
|
/**
|
|
20
20
|
* The name of the hostname resource.
|
|
21
21
|
* <p>
|
|
22
|
-
Example:
|
|
22
|
+
Example: {@code example_hostname_001}
|
|
23
23
|
*
|
|
24
24
|
*/
|
|
25
25
|
"name": string;
|
|
@@ -27,7 +27,7 @@ export interface HostnameDetails {
|
|
|
27
27
|
* A virtual hostname. For more information about virtual hostname string construction, see
|
|
28
28
|
* [Managing Request Routing](https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
|
|
29
29
|
* <p>
|
|
30
|
-
Example:
|
|
30
|
+
Example: {@code app.example.com}
|
|
31
31
|
*
|
|
32
32
|
*/
|
|
33
33
|
"hostname": string;
|
package/lib/model/hostname.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export interface Hostname {
|
|
|
23
23
|
* A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential
|
|
24
24
|
* information.
|
|
25
25
|
* <p>
|
|
26
|
-
Example:
|
|
26
|
+
Example: {@code example_hostname_001}
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
"name": string;
|
|
@@ -31,7 +31,7 @@ export interface Hostname {
|
|
|
31
31
|
* A virtual hostname. For more information about virtual hostname string construction, see
|
|
32
32
|
* [Managing Request Routing](https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
|
|
33
33
|
* <p>
|
|
34
|
-
Example:
|
|
34
|
+
Example: {@code app.example.com}
|
|
35
35
|
*
|
|
36
36
|
*/
|
|
37
37
|
"hostname": string;
|
|
@@ -17,7 +17,7 @@ import * as model from "../model";
|
|
|
17
17
|
* An object that represents the advance http header options that allow the setting of http header size and allow/disallow
|
|
18
18
|
* invalid characters in the http headers.
|
|
19
19
|
* For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each
|
|
20
|
-
* This rule applies only to HTTP listeners. No more than one
|
|
20
|
+
* This rule applies only to HTTP listeners. No more than one {@code HttpHeaderRule} object can be present in
|
|
21
21
|
* a given listener.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
@@ -28,12 +28,12 @@ Path route rules take precedence to determine the target backend server. The loa
|
|
|
28
28
|
* target. The system ignores invalid cookies.
|
|
29
29
|
* <p>
|
|
30
30
|
To disable LB cookie stickiness on a running load balancer, use the
|
|
31
|
-
* {@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify
|
|
32
|
-
*
|
|
31
|
+
* {@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify {@code null} for the
|
|
32
|
+
* {@code LBCookieSessionPersistenceConfigurationDetails} object.
|
|
33
33
|
* <p>
|
|
34
|
-
Example:
|
|
34
|
+
Example: {@code LBCookieSessionPersistenceConfigurationDetails: null}
|
|
35
35
|
* <p>
|
|
36
|
-
**Note:**
|
|
36
|
+
**Note:** {@code SessionPersistenceConfigurationDetails} (application cookie stickiness) and {@code LBCookieSessionPersistenceConfigurationDetails}
|
|
37
37
|
* (LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.
|
|
38
38
|
* <p>
|
|
39
39
|
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
|
|
@@ -44,7 +44,7 @@ export interface LBCookieSessionPersistenceConfigurationDetails {
|
|
|
44
44
|
* The name of the cookie inserted by the load balancer. If this field is not configured, the cookie name defaults
|
|
45
45
|
* to \"X-Oracle-BMC-LBS-Route\".
|
|
46
46
|
* <p>
|
|
47
|
-
Example:
|
|
47
|
+
Example: {@code example_cookie}
|
|
48
48
|
* <p>
|
|
49
49
|
**Notes:**
|
|
50
50
|
* <p>
|
|
@@ -54,9 +54,9 @@ export interface LBCookieSessionPersistenceConfigurationDetails {
|
|
|
54
54
|
* <p>
|
|
55
55
|
* If a backend server and the load balancer both insert cookies with the same name, the client or browser
|
|
56
56
|
* behavior can vary depending on the domain and path values associated with the cookie. If the name, domain,
|
|
57
|
-
* and path values of the
|
|
57
|
+
* and path values of the {@code Set-cookie} generated by a backend server and the {@code Set-cookie} generated by the
|
|
58
58
|
* load balancer are all the same, the client or browser treats them as one cookie and returns only one of
|
|
59
|
-
* the cookie values in subsequent requests. If both
|
|
59
|
+
* the cookie values in subsequent requests. If both {@code Set-cookie} names are the same, but the domain and path
|
|
60
60
|
* names are different, the client or browser treats them as two different cookies.
|
|
61
61
|
*
|
|
62
62
|
*/
|
|
@@ -65,81 +65,81 @@ export interface LBCookieSessionPersistenceConfigurationDetails {
|
|
|
65
65
|
* Whether the load balancer is prevented from directing traffic from a persistent session client to
|
|
66
66
|
* a different backend server if the original server is unavailable. Defaults to false.
|
|
67
67
|
* <p>
|
|
68
|
-
Example:
|
|
68
|
+
Example: {@code false}
|
|
69
69
|
*
|
|
70
70
|
*/
|
|
71
71
|
"disableFallback"?: boolean;
|
|
72
72
|
/**
|
|
73
|
-
* The domain in which the cookie is valid. The
|
|
73
|
+
* The domain in which the cookie is valid. The {@code Set-cookie} header inserted by the load balancer contains a
|
|
74
74
|
* domain attribute with the specified value.
|
|
75
75
|
* <p>
|
|
76
76
|
This attribute has no default value. If you do not specify a value, the load balancer does not insert the domain
|
|
77
|
-
* attribute into the
|
|
77
|
+
* attribute into the {@code Set-cookie} header.
|
|
78
78
|
* <p>
|
|
79
79
|
**Notes:**
|
|
80
80
|
* <p>
|
|
81
81
|
* [RFC 6265 - HTTP State Management Mechanism](https://www.ietf.org/rfc/rfc6265.txt) describes client and
|
|
82
|
-
* browser behavior when the domain attribute is present or not present in the
|
|
82
|
+
* browser behavior when the domain attribute is present or not present in the {@code Set-cookie} header.
|
|
83
83
|
* <p>
|
|
84
|
-
If the value of the
|
|
85
|
-
* the same cookie in the
|
|
86
|
-
*
|
|
84
|
+
If the value of the {@code Domain} attribute is {@code example.com} in the {@code Set-cookie} header, the client includes
|
|
85
|
+
* the same cookie in the {@code Cookie} header when making HTTP requests to {@code example.com}, {@code www.example.com}, and
|
|
86
|
+
* {@code www.abc.example.com}. If the {@code Domain} attribute is not present, the client returns the cookie only for
|
|
87
87
|
* the domain to which the original request was made.
|
|
88
88
|
* <p>
|
|
89
|
-
* Ensure that this attribute specifies the correct domain value. If the
|
|
89
|
+
* Ensure that this attribute specifies the correct domain value. If the {@code Domain} attribute in the {@code Set-cookie}
|
|
90
90
|
* header does not include the domain to which the original request was made, the client or browser might reject
|
|
91
|
-
* the cookie. As specified in RFC 6265, the client accepts a cookie with the
|
|
92
|
-
* or
|
|
93
|
-
*
|
|
91
|
+
* the cookie. As specified in RFC 6265, the client accepts a cookie with the {@code Domain} attribute value {@code example.com}
|
|
92
|
+
* or {@code www.example.com} sent from {@code www.example.com}. It does not accept a cookie with the {@code Domain} attribute
|
|
93
|
+
* {@code abc.example.com} or {@code www.abc.example.com} sent from {@code www.example.com}.
|
|
94
94
|
* <p>
|
|
95
|
-
Example:
|
|
95
|
+
Example: {@code example.com}
|
|
96
96
|
*
|
|
97
97
|
*/
|
|
98
98
|
"domain"?: string;
|
|
99
99
|
/**
|
|
100
|
-
* The path in which the cookie is valid. The
|
|
100
|
+
* The path in which the cookie is valid. The {@code Set-cookie header} inserted by the load balancer contains a {@code Path}
|
|
101
101
|
* attribute with the specified value.
|
|
102
102
|
* <p>
|
|
103
103
|
Clients include the cookie in an HTTP request only if the path portion of the request-uri matches, or is a
|
|
104
|
-
* subdirectory of, the cookie's
|
|
104
|
+
* subdirectory of, the cookie's {@code Path} attribute.
|
|
105
105
|
* <p>
|
|
106
|
-
The default value is
|
|
106
|
+
The default value is {@code /}.
|
|
107
107
|
* <p>
|
|
108
|
-
Example:
|
|
108
|
+
Example: {@code /example}
|
|
109
109
|
*
|
|
110
110
|
*/
|
|
111
111
|
"path"?: string;
|
|
112
112
|
/**
|
|
113
|
-
* The amount of time the cookie remains valid. The
|
|
114
|
-
* a
|
|
113
|
+
* The amount of time the cookie remains valid. The {@code Set-cookie} header inserted by the load balancer contains
|
|
114
|
+
* a {@code Max-Age} attribute with the specified value.
|
|
115
115
|
* <p>
|
|
116
116
|
The specified value must be at least one second. There is no default value for this attribute. If you do not
|
|
117
|
-
* specify a value, the load balancer does not include the
|
|
117
|
+
* specify a value, the load balancer does not include the {@code Max-Age} attribute in the {@code Set-cookie} header. In
|
|
118
118
|
* most cases, the client or browser retains the cookie until the current session ends, as defined by the client.
|
|
119
119
|
* <p>
|
|
120
|
-
Example:
|
|
120
|
+
Example: {@code 3600}
|
|
121
121
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
122
122
|
*/
|
|
123
123
|
"maxAgeInSeconds"?: number;
|
|
124
124
|
/**
|
|
125
|
-
* Whether the
|
|
126
|
-
* inserted by the load balancer contains the
|
|
125
|
+
* Whether the {@code Set-cookie} header should contain the {@code Secure} attribute. If {@code true}, the {@code Set-cookie} header
|
|
126
|
+
* inserted by the load balancer contains the {@code Secure} attribute, which directs the client or browser to send the
|
|
127
127
|
* cookie only using a secure protocol.
|
|
128
128
|
* <p>
|
|
129
|
-
**Note:** If you set this field to
|
|
129
|
+
**Note:** If you set this field to {@code true}, you cannot associate the corresponding backend set with an HTTP
|
|
130
130
|
* listener.
|
|
131
131
|
* <p>
|
|
132
|
-
Example:
|
|
132
|
+
Example: {@code true}
|
|
133
133
|
*
|
|
134
134
|
*/
|
|
135
135
|
"isSecure"?: boolean;
|
|
136
136
|
/**
|
|
137
|
-
* Whether the
|
|
138
|
-
* inserted by the load balancer contains the
|
|
137
|
+
* Whether the {@code Set-cookie} header should contain the {@code HttpOnly} attribute. If {@code true}, the {@code Set-cookie} header
|
|
138
|
+
* inserted by the load balancer contains the {@code HttpOnly} attribute, which limits the scope of the cookie to HTTP
|
|
139
139
|
* requests. This attribute directs the client or browser to omit the cookie when providing access to cookies
|
|
140
140
|
* through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels.
|
|
141
141
|
* <p>
|
|
142
|
-
Example:
|
|
142
|
+
Example: {@code true}
|
|
143
143
|
*
|
|
144
144
|
*/
|
|
145
145
|
"isHttpOnly"?: boolean;
|
|
@@ -20,14 +20,14 @@ export interface ListenerDetails {
|
|
|
20
20
|
/**
|
|
21
21
|
* The name of the associated backend set.
|
|
22
22
|
* <p>
|
|
23
|
-
Example:
|
|
23
|
+
Example: {@code example_backend_set}
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
"defaultBackendSetName": string;
|
|
27
27
|
/**
|
|
28
28
|
* The communication port for the listener.
|
|
29
29
|
* <p>
|
|
30
|
-
Example:
|
|
30
|
+
Example: {@code 80}
|
|
31
31
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
32
32
|
*/
|
|
33
33
|
"port": number;
|
|
@@ -36,7 +36,7 @@ export interface ListenerDetails {
|
|
|
36
36
|
* To get a list of valid protocols, use the {@link #listProtocols(ListProtocolsRequest) listProtocols}
|
|
37
37
|
* operation.
|
|
38
38
|
* <p>
|
|
39
|
-
Example:
|
|
39
|
+
Example: {@code HTTP}
|
|
40
40
|
*
|
|
41
41
|
*/
|
|
42
42
|
"protocol": string;
|
|
@@ -45,12 +45,12 @@ export interface ListenerDetails {
|
|
|
45
45
|
*/
|
|
46
46
|
"hostnameNames"?: Array<string>;
|
|
47
47
|
/**
|
|
48
|
-
* Deprecated. Please use
|
|
48
|
+
* Deprecated. Please use {@code routingPolicies} instead.
|
|
49
49
|
* <p>
|
|
50
50
|
The name of the set of path-based routing rules, {@link PathRouteSet},
|
|
51
51
|
* applied to this listener's traffic.
|
|
52
52
|
* <p>
|
|
53
|
-
Example:
|
|
53
|
+
Example: {@code example_path_route_set}
|
|
54
54
|
*
|
|
55
55
|
*/
|
|
56
56
|
"pathRouteSetName"?: string;
|
|
@@ -59,7 +59,7 @@ export interface ListenerDetails {
|
|
|
59
59
|
/**
|
|
60
60
|
* The name of the routing policy applied to this listener's traffic.
|
|
61
61
|
* <p>
|
|
62
|
-
Example:
|
|
62
|
+
Example: {@code example_routing_policy}
|
|
63
63
|
*
|
|
64
64
|
*/
|
|
65
65
|
"routingPolicyName"?: string;
|
package/lib/model/listener.d.ts
CHANGED
|
@@ -23,21 +23,21 @@ export interface Listener {
|
|
|
23
23
|
/**
|
|
24
24
|
* A friendly name for the listener. It must be unique and it cannot be changed.
|
|
25
25
|
* <p>
|
|
26
|
-
Example:
|
|
26
|
+
Example: {@code example_listener}
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
"name": string;
|
|
30
30
|
/**
|
|
31
31
|
* The name of the associated backend set.
|
|
32
32
|
* <p>
|
|
33
|
-
Example:
|
|
33
|
+
Example: {@code example_backend_set}
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"defaultBackendSetName": string;
|
|
37
37
|
/**
|
|
38
38
|
* The communication port for the listener.
|
|
39
39
|
* <p>
|
|
40
|
-
Example:
|
|
40
|
+
Example: {@code 80}
|
|
41
41
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
42
42
|
*/
|
|
43
43
|
"port": number;
|
|
@@ -46,7 +46,7 @@ export interface Listener {
|
|
|
46
46
|
* To get a list of valid protocols, use the {@link #listProtocols(ListProtocolsRequest) listProtocols}
|
|
47
47
|
* operation.
|
|
48
48
|
* <p>
|
|
49
|
-
Example:
|
|
49
|
+
Example: {@code HTTP}
|
|
50
50
|
*
|
|
51
51
|
*/
|
|
52
52
|
"protocol": string;
|
|
@@ -55,12 +55,12 @@ export interface Listener {
|
|
|
55
55
|
*/
|
|
56
56
|
"hostnameNames"?: Array<string>;
|
|
57
57
|
/**
|
|
58
|
-
* Deprecated. Please use
|
|
58
|
+
* Deprecated. Please use {@code routingPolicies} instead.
|
|
59
59
|
* <p>
|
|
60
60
|
The name of the set of path-based routing rules, {@link PathRouteSet},
|
|
61
61
|
* applied to this listener's traffic.
|
|
62
62
|
* <p>
|
|
63
|
-
Example:
|
|
63
|
+
Example: {@code example_path_route_set}
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
66
|
"pathRouteSetName"?: string;
|
|
@@ -76,7 +76,7 @@ export interface Listener {
|
|
|
76
76
|
/**
|
|
77
77
|
* The name of the routing policy applied to this listener's traffic.
|
|
78
78
|
* <p>
|
|
79
|
-
Example:
|
|
79
|
+
Example: {@code example_routing_policy_name}
|
|
80
80
|
*
|
|
81
81
|
*/
|
|
82
82
|
"routingPolicyName"?: string;
|
|
@@ -24,21 +24,21 @@ export interface LoadBalancerHealthSummary {
|
|
|
24
24
|
/**
|
|
25
25
|
* The overall health status of the load balancer.
|
|
26
26
|
* <p>
|
|
27
|
-
* **OK:** All backend sets associated with the load balancer return a status of
|
|
27
|
+
* **OK:** All backend sets associated with the load balancer return a status of {@code OK}.
|
|
28
28
|
* <p>
|
|
29
|
-
* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of
|
|
30
|
-
* no backend sets return a status of
|
|
29
|
+
* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of {@code WARNING},
|
|
30
|
+
* no backend sets return a status of {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
|
|
31
31
|
* <p>
|
|
32
|
-
* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of
|
|
32
|
+
* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of {@code CRITICAL}.
|
|
33
33
|
* <p>
|
|
34
34
|
* **UNKNOWN:** If any one of the following conditions is true:
|
|
35
35
|
* <p>
|
|
36
|
-
* The load balancer life cycle state is not
|
|
36
|
+
* The load balancer life cycle state is not {@code ACTIVE}.
|
|
37
37
|
* <p>
|
|
38
38
|
* No backend sets are defined for the load balancer.
|
|
39
39
|
* <p>
|
|
40
|
-
* More than half of the backend sets associated with the load balancer return a status of
|
|
41
|
-
* sets return a status of
|
|
40
|
+
* More than half of the backend sets associated with the load balancer return a status of {@code UNKNOWN}, none of the backend
|
|
41
|
+
* sets return a status of {@code WARNING} or {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
|
|
42
42
|
* <p>
|
|
43
43
|
* The system could not retrieve metrics for any reason.
|
|
44
44
|
*
|