oci-loadbalancer 2.76.1 → 2.77.0
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 +61 -61
- package/lib/client.js +61 -61
- 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
|
@@ -15,62 +15,62 @@ information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/bal
|
|
|
15
15
|
/**
|
|
16
16
|
* The health status details for the specified load balancer.
|
|
17
17
|
* <p>
|
|
18
|
-
This object does not explicitly enumerate backend sets with a status of
|
|
19
|
-
*
|
|
18
|
+
This object does not explicitly enumerate backend sets with a status of {@code OK}. However, they are included in the
|
|
19
|
+
* {@code totalBackendSetCount} sum.
|
|
20
20
|
*
|
|
21
21
|
*/
|
|
22
22
|
export interface LoadBalancerHealth {
|
|
23
23
|
/**
|
|
24
24
|
* The overall health status of the load balancer.
|
|
25
25
|
* <p>
|
|
26
|
-
* **OK:** All backend sets associated with the load balancer return a status of
|
|
26
|
+
* **OK:** All backend sets associated with the load balancer return a status of {@code OK}.
|
|
27
27
|
* <p>
|
|
28
|
-
* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of
|
|
29
|
-
* no backend sets return a status of
|
|
28
|
+
* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of {@code WARNING},
|
|
29
|
+
* no backend sets return a status of {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
|
|
30
30
|
* <p>
|
|
31
|
-
* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of
|
|
31
|
+
* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of {@code CRITICAL}.
|
|
32
32
|
* <p>
|
|
33
33
|
* **UNKNOWN:** If any one of the following conditions is true:
|
|
34
34
|
* <p>
|
|
35
|
-
* The load balancer life cycle state is not
|
|
35
|
+
* The load balancer life cycle state is not {@code ACTIVE}.
|
|
36
36
|
* <p>
|
|
37
37
|
* No backend sets are defined for the load balancer.
|
|
38
38
|
* <p>
|
|
39
|
-
* More than half of the backend sets associated with the load balancer return a status of
|
|
40
|
-
* sets return a status of
|
|
39
|
+
* More than half of the backend sets associated with the load balancer return a status of {@code UNKNOWN}, none of the backend
|
|
40
|
+
* sets return a status of {@code WARNING} or {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
|
|
41
41
|
* <p>
|
|
42
42
|
* The system could not retrieve metrics for any reason.
|
|
43
43
|
*
|
|
44
44
|
*/
|
|
45
45
|
"status": LoadBalancerHealth.Status;
|
|
46
46
|
/**
|
|
47
|
-
* A list of backend sets that are currently in the
|
|
47
|
+
* A list of backend sets that are currently in the {@code WARNING} health state. The list identifies each backend set by the
|
|
48
48
|
* friendly name you assigned when you created it.
|
|
49
49
|
* <p>
|
|
50
|
-
Example:
|
|
50
|
+
Example: {@code example_backend_set3}
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
53
|
"warningStateBackendSetNames": Array<string>;
|
|
54
54
|
/**
|
|
55
|
-
* A list of backend sets that are currently in the
|
|
55
|
+
* A list of backend sets that are currently in the {@code CRITICAL} health state. The list identifies each backend set by the
|
|
56
56
|
* friendly name you assigned when you created it.
|
|
57
57
|
* <p>
|
|
58
|
-
Example:
|
|
58
|
+
Example: {@code example_backend_set}
|
|
59
59
|
*
|
|
60
60
|
*/
|
|
61
61
|
"criticalStateBackendSetNames": Array<string>;
|
|
62
62
|
/**
|
|
63
|
-
* A list of backend sets that are currently in the
|
|
63
|
+
* A list of backend sets that are currently in the {@code UNKNOWN} health state. The list identifies each backend set by the
|
|
64
64
|
* friendly name you assigned when you created it.
|
|
65
65
|
* <p>
|
|
66
|
-
Example:
|
|
66
|
+
Example: {@code example_backend_set2}
|
|
67
67
|
*
|
|
68
68
|
*/
|
|
69
69
|
"unknownStateBackendSetNames": Array<string>;
|
|
70
70
|
/**
|
|
71
71
|
* The total number of backend sets associated with this load balancer.
|
|
72
72
|
* <p>
|
|
73
|
-
Example:
|
|
73
|
+
Example: {@code 4}
|
|
74
74
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
75
75
|
*/
|
|
76
76
|
"totalBackendSetCount": number;
|
|
@@ -38,7 +38,7 @@ export interface LoadBalancer {
|
|
|
38
38
|
/**
|
|
39
39
|
* A user-friendly name. It does not have to be unique, and it is changeable.
|
|
40
40
|
* <p>
|
|
41
|
-
Example:
|
|
41
|
+
Example: {@code example_load_balancer}
|
|
42
42
|
*
|
|
43
43
|
*/
|
|
44
44
|
"displayName": string;
|
|
@@ -50,7 +50,7 @@ export interface LoadBalancer {
|
|
|
50
50
|
/**
|
|
51
51
|
* The date and time the load balancer was created, in the format defined by RFC3339.
|
|
52
52
|
* <p>
|
|
53
|
-
Example:
|
|
53
|
+
Example: {@code 2016-08-25T21:10:29.600Z}
|
|
54
54
|
*
|
|
55
55
|
*/
|
|
56
56
|
"timeCreated": Date;
|
|
@@ -64,7 +64,7 @@ export interface LoadBalancer {
|
|
|
64
64
|
* To get a list of available shapes, use the {@link #listShapes(ListShapesRequest) listShapes}
|
|
65
65
|
* operation.
|
|
66
66
|
* <p>
|
|
67
|
-
Example:
|
|
67
|
+
Example: {@code 100Mbps}
|
|
68
68
|
*
|
|
69
69
|
*/
|
|
70
70
|
"shapeName": string;
|
|
@@ -80,7 +80,7 @@ export interface LoadBalancer {
|
|
|
80
80
|
* [security list rules](https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and
|
|
81
81
|
* private load balancers, see [How Load Balancing Works](https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
|
|
82
82
|
* <p>
|
|
83
|
-
Example:
|
|
83
|
+
Example: {@code true}
|
|
84
84
|
*
|
|
85
85
|
*/
|
|
86
86
|
"isPrivate"?: boolean;
|
|
@@ -127,7 +127,7 @@ export interface LoadBalancer {
|
|
|
127
127
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
128
128
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
129
129
|
* <p>
|
|
130
|
-
Example:
|
|
130
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
131
131
|
*
|
|
132
132
|
*/
|
|
133
133
|
"freeformTags"?: {
|
|
@@ -137,7 +137,7 @@ export interface LoadBalancer {
|
|
|
137
137
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
138
138
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
139
139
|
* <p>
|
|
140
|
-
Example:
|
|
140
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
141
141
|
*
|
|
142
142
|
*/
|
|
143
143
|
"definedTags"?: {
|
|
@@ -150,7 +150,7 @@ export interface LoadBalancer {
|
|
|
150
150
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
151
151
|
* System tags can be viewed by users, but can only be created by the system.
|
|
152
152
|
* <p>
|
|
153
|
-
Example:
|
|
153
|
+
Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}
|
|
154
154
|
*
|
|
155
155
|
*/
|
|
156
156
|
"systemTags"?: {
|
|
@@ -21,23 +21,23 @@ export interface PathMatchCondition extends model.RuleCondition {
|
|
|
21
21
|
/**
|
|
22
22
|
* The path string that the redirection rule applies to.
|
|
23
23
|
* <p>
|
|
24
|
-
Example:
|
|
24
|
+
Example: {@code /example}
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
"attributeValue": string;
|
|
28
28
|
/**
|
|
29
|
-
* A string that specifies how to compare the PathMatchCondition object's
|
|
29
|
+
* A string that specifies how to compare the PathMatchCondition object's {@code attributeValue} string to the
|
|
30
30
|
* incoming URI.
|
|
31
31
|
* <p>
|
|
32
|
-
* **EXACT_MATCH** - The incoming URI path must exactly and completely match the
|
|
32
|
+
* **EXACT_MATCH** - The incoming URI path must exactly and completely match the {@code attributeValue} string.
|
|
33
33
|
* <p>
|
|
34
|
-
* **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the
|
|
34
|
+
* **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the {@code attributeValue} string with the best,
|
|
35
35
|
* longest match of the beginning portion of the incoming URI path.
|
|
36
36
|
* <p>
|
|
37
37
|
* **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the
|
|
38
|
-
*
|
|
38
|
+
* {@code attributeValue} string.
|
|
39
39
|
* <p>
|
|
40
|
-
* **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the
|
|
40
|
+
* **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the {@code attributeValue}
|
|
41
41
|
* string.
|
|
42
42
|
*
|
|
43
43
|
*/
|
|
@@ -18,18 +18,18 @@ information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/bal
|
|
|
18
18
|
export interface PathMatchType {
|
|
19
19
|
/**
|
|
20
20
|
* Specifies how the load balancing service compares a {@link #pathRoute(PathRouteRequest) pathRoute}
|
|
21
|
-
* object's
|
|
21
|
+
* object's {@code path} string against the incoming URI.
|
|
22
22
|
* <p>
|
|
23
|
-
* **EXACT_MATCH** - Looks for a
|
|
23
|
+
* **EXACT_MATCH** - Looks for a {@code path} string that exactly matches the incoming URI path.
|
|
24
24
|
* <p>
|
|
25
|
-
* **FORCE_LONGEST_PREFIX_MATCH** - Looks for the
|
|
25
|
+
* **FORCE_LONGEST_PREFIX_MATCH** - Looks for the {@code path} string with the best, longest match of the beginning
|
|
26
26
|
* portion of the incoming URI path.
|
|
27
27
|
* <p>
|
|
28
|
-
* **PREFIX_MATCH** - Looks for a
|
|
28
|
+
* **PREFIX_MATCH** - Looks for a {@code path} string that matches the beginning portion of the incoming URI path.
|
|
29
29
|
* <p>
|
|
30
|
-
* **SUFFIX_MATCH** - Looks for a
|
|
30
|
+
* **SUFFIX_MATCH** - Looks for a {@code path} string that matches the ending portion of the incoming URI path.
|
|
31
31
|
* <p>
|
|
32
|
-
For a full description of how the system handles
|
|
32
|
+
For a full description of how the system handles {@code matchType} in a path route set containing multiple rules, see
|
|
33
33
|
* [Managing Request Routing](https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
@@ -29,7 +29,7 @@ export interface PathRoute {
|
|
|
29
29
|
* <p>
|
|
30
30
|
* Regular expressions are not supported.
|
|
31
31
|
* <p>
|
|
32
|
-
Example:
|
|
32
|
+
Example: {@code /example/video/123}
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
"path": string;
|
|
@@ -40,7 +40,7 @@ export interface PathRoute {
|
|
|
40
40
|
/**
|
|
41
41
|
* The name of the target backend set for requests where the incoming URI matches the specified path.
|
|
42
42
|
* <p>
|
|
43
|
-
Example:
|
|
43
|
+
Example: {@code example_backend_set}
|
|
44
44
|
*
|
|
45
45
|
*/
|
|
46
46
|
"backendSetName": string;
|
|
@@ -17,14 +17,14 @@ import * as model from "../model";
|
|
|
17
17
|
* An object that represents the action of returning a specified response code and a redirect URI. Each RedirectRule
|
|
18
18
|
* object is configured for a particular listener and a designated path.
|
|
19
19
|
* <p>
|
|
20
|
-
The default response code is
|
|
20
|
+
The default response code is {@code 302 Found}.
|
|
21
21
|
* <p>
|
|
22
22
|
**NOTES:**
|
|
23
23
|
* * This rule applies only to HTTP listeners.
|
|
24
24
|
* * You can specify this rule only with the {@link #ruleCondition(RuleConditionRequest) ruleCondition}
|
|
25
|
-
* type
|
|
25
|
+
* type {@code PATH}.
|
|
26
26
|
* * A listener can have only one RedirectRule object for a given original path. The
|
|
27
|
-
* {@link #pathMatchCondition(PathMatchConditionRequest) pathMatchCondition}
|
|
27
|
+
* {@link #pathMatchCondition(PathMatchConditionRequest) pathMatchCondition} {@code attributeValue} specifies the
|
|
28
28
|
* original path.
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
@@ -41,9 +41,9 @@ export interface RedirectRule extends model.Rule {
|
|
|
41
41
|
* * 307
|
|
42
42
|
* * 308
|
|
43
43
|
* <p>
|
|
44
|
-
The default value is
|
|
44
|
+
The default value is {@code 302} (Found).
|
|
45
45
|
* <p>
|
|
46
|
-
Example:
|
|
46
|
+
Example: {@code 301}
|
|
47
47
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
48
48
|
*/
|
|
49
49
|
"responseCode"?: number;
|
|
@@ -20,9 +20,9 @@ information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/bal
|
|
|
20
20
|
* meaningful, complete, and correct field values. If any component field of this object has no value, the system
|
|
21
21
|
* retains the value from the incoming HTTP request URI.
|
|
22
22
|
* <p>
|
|
23
|
-
For example, if you specify only the protocol field
|
|
24
|
-
*
|
|
25
|
-
* the host and port from the incoming URI and does not automatically change the port setting from
|
|
23
|
+
For example, if you specify only the protocol field {@code https}, and the incoming request URI is
|
|
24
|
+
* {@code http://example.com:8080}, the resulting runtime redirect URI is {@code https://example.com:8080}. The system retains
|
|
25
|
+
* the host and port from the incoming URI and does not automatically change the port setting from {@code 8080} to {@code 443}.
|
|
26
26
|
* <p>
|
|
27
27
|
Be sure to configure valid percent-encoding (URL encoding) when needed.
|
|
28
28
|
* <p>
|
|
@@ -35,55 +35,55 @@ In addition to static string values, you can use the following tokens to constru
|
|
|
35
35
|
* * {path} : The path from the incoming HTTP request URI.
|
|
36
36
|
* * {query} : The query string from the incoming HTTP request URI.
|
|
37
37
|
* <p>
|
|
38
|
-
The tokens are case sensitive. For example,
|
|
38
|
+
The tokens are case sensitive. For example, {@code {host}} is a valid token, but {@code {HOST}} is not.
|
|
39
39
|
* <p>
|
|
40
40
|
You can retain the literal characters of a token when you specify values for the path and query properties of the
|
|
41
41
|
* redirect URI. Use a backslash (\\\\) as the escape character for the \\\\, {, and } characters. For example, if the
|
|
42
|
-
* incoming HTTP request URI is
|
|
42
|
+
* incoming HTTP request URI is {@code /video}, the path property value:
|
|
43
43
|
* <p>
|
|
44
|
-
|
|
44
|
+
{@code /example{path}123\\{path\\}}
|
|
45
45
|
* <p>
|
|
46
46
|
appears in the constructed redirect URI as:
|
|
47
47
|
* <p>
|
|
48
|
-
|
|
48
|
+
{@code /example/video123{path}}
|
|
49
49
|
*
|
|
50
50
|
*/
|
|
51
51
|
export interface RedirectUri {
|
|
52
52
|
/**
|
|
53
53
|
* The HTTP protocol to use in the redirect URI.
|
|
54
54
|
* <p>
|
|
55
|
-
When this value is null, not set, or set to
|
|
55
|
+
When this value is null, not set, or set to {@code {protocol}}, the service preserves the original protocol from the
|
|
56
56
|
* incoming HTTP request URI. Allowed values are:
|
|
57
57
|
* <p>
|
|
58
58
|
* HTTP
|
|
59
59
|
* * HTTPS
|
|
60
60
|
* * {protocol}
|
|
61
61
|
* <p>
|
|
62
|
-
|
|
62
|
+
{@code {protocol}} is the only valid token for this property. It can appear only once in the value string.
|
|
63
63
|
* <p>
|
|
64
|
-
Example:
|
|
64
|
+
Example: {@code HTTPS}
|
|
65
65
|
*
|
|
66
66
|
*/
|
|
67
67
|
"protocol"?: string;
|
|
68
68
|
/**
|
|
69
69
|
* The valid domain name (hostname) or IP address to use in the redirect URI.
|
|
70
70
|
* <p>
|
|
71
|
-
When this value is null, not set, or set to
|
|
71
|
+
When this value is null, not set, or set to {@code {host}}, the service preserves the original domain name from the
|
|
72
72
|
* incoming HTTP request URI.
|
|
73
73
|
* <p>
|
|
74
74
|
All RedirectUri tokens are valid for this property. You can use any token more than once.
|
|
75
75
|
* <p>
|
|
76
|
-
Curly braces are valid in this property only to surround tokens, such as
|
|
76
|
+
Curly braces are valid in this property only to surround tokens, such as {@code {host}}
|
|
77
77
|
* <p>
|
|
78
78
|
Examples:
|
|
79
79
|
* <p>
|
|
80
|
-
* **example.com** appears as
|
|
80
|
+
* **example.com** appears as {@code example.com} in the redirect URI.
|
|
81
81
|
* <p>
|
|
82
|
-
* **in{host}** appears as
|
|
82
|
+
* **in{host}** appears as {@code inexample.com} in the redirect URI if {@code example.com} is the hostname in the
|
|
83
83
|
* incoming HTTP request URI.
|
|
84
84
|
* <p>
|
|
85
|
-
* **{port}{host}** appears as
|
|
86
|
-
* the port is
|
|
85
|
+
* **{port}{host}** appears as {@code 8081example.com} in the redirect URI if {@code example.com} is the hostname and
|
|
86
|
+
* the port is {@code 8081} in the incoming HTTP request URI.
|
|
87
87
|
*
|
|
88
88
|
*/
|
|
89
89
|
"host"?: string;
|
|
@@ -94,40 +94,40 @@ export interface RedirectUri {
|
|
|
94
94
|
* <p>
|
|
95
95
|
When this value is null, the service preserves the original port from the incoming HTTP request URI.
|
|
96
96
|
* <p>
|
|
97
|
-
Example:
|
|
97
|
+
Example: {@code 8081}
|
|
98
98
|
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
99
99
|
*/
|
|
100
100
|
"port"?: number;
|
|
101
101
|
/**
|
|
102
102
|
* The HTTP URI path to use in the redirect URI.
|
|
103
103
|
* <p>
|
|
104
|
-
When this value is null, not set, or set to
|
|
104
|
+
When this value is null, not set, or set to {@code {path}}, the service preserves the original path from the
|
|
105
105
|
* incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, \"\".
|
|
106
106
|
* <p>
|
|
107
107
|
All RedirectUri tokens are valid for this property. You can use any token more than once.
|
|
108
108
|
* <p>
|
|
109
|
-
The path string must begin with
|
|
109
|
+
The path string must begin with {@code /} if it does not begin with the {@code {path}} token.
|
|
110
110
|
* <p>
|
|
111
111
|
Examples:
|
|
112
112
|
* <p>
|
|
113
|
-
* __/example/video/123__ appears as
|
|
113
|
+
* __/example/video/123__ appears as {@code /example/video/123} in the redirect URI.
|
|
114
114
|
* <p>
|
|
115
|
-
* __/example{path}__ appears as
|
|
115
|
+
* __/example{path}__ appears as {@code /example/video/123} in the redirect URI if {@code /video/123} is the path in the
|
|
116
116
|
* incoming HTTP request URI.
|
|
117
117
|
* <p>
|
|
118
|
-
* __{path}/123__ appears as
|
|
118
|
+
* __{path}/123__ appears as {@code /example/video/123} in the redirect URI if {@code /example/video} is the path in the
|
|
119
119
|
* incoming HTTP request URI.
|
|
120
120
|
* <p>
|
|
121
|
-
* __{path}123__ appears as
|
|
121
|
+
* __{path}123__ appears as {@code /example/video123} in the redirect URI if {@code /example/video} is the path in the
|
|
122
122
|
* incoming HTTP request URI.
|
|
123
123
|
* <p>
|
|
124
|
-
* __/{host}/123__ appears as
|
|
124
|
+
* __/{host}/123__ appears as {@code /example.com/123} in the redirect URI if {@code example.com} is the hostname
|
|
125
125
|
* in the incoming HTTP request URI.
|
|
126
126
|
* <p>
|
|
127
|
-
* __/{host}/{port}__ appears as
|
|
128
|
-
*
|
|
127
|
+
* __/{host}/{port}__ appears as {@code /example.com/123} in the redirect URI if {@code example.com} is the hostname and
|
|
128
|
+
* {@code 123} is the port in the incoming HTTP request URI.
|
|
129
129
|
* <p>
|
|
130
|
-
* __/{query}__ appears as
|
|
130
|
+
* __/{query}__ appears as {@code /lang=en} in the redirect URI if the query is {@code lang=en} in the incoming HTTP
|
|
131
131
|
* request URI.
|
|
132
132
|
*
|
|
133
133
|
*/
|
|
@@ -135,38 +135,38 @@ export interface RedirectUri {
|
|
|
135
135
|
/**
|
|
136
136
|
* The query string to use in the redirect URI.
|
|
137
137
|
* <p>
|
|
138
|
-
When this value is null, not set, or set to
|
|
138
|
+
When this value is null, not set, or set to {@code {query}}, the service preserves the original query parameters
|
|
139
139
|
* from the incoming HTTP request URI.
|
|
140
140
|
* <p>
|
|
141
|
-
All
|
|
141
|
+
All {@code RedirectUri} tokens are valid for this property. You can use any token more than once.
|
|
142
142
|
* <p>
|
|
143
|
-
If the query string does not begin with the
|
|
143
|
+
If the query string does not begin with the {@code {query}} token, it must begin with the question mark (?) character.
|
|
144
144
|
* <p>
|
|
145
145
|
You can specify multiple query parameters as a single string. Separate each query parameter with an ampersand
|
|
146
146
|
* (&) character. To omit all incoming query parameters from the redirect URI, set this value to an empty
|
|
147
147
|
* string, \"\".
|
|
148
148
|
* <p>
|
|
149
|
-
If the specified query string results in a redirect URI ending with
|
|
150
|
-
* For example, if the incoming URI is
|
|
151
|
-
*
|
|
149
|
+
If the specified query string results in a redirect URI ending with {@code ?} or {@code &}, the last character is truncated.
|
|
150
|
+
* For example, if the incoming URI is {@code http://host.com:8080/documents} and the query property value is
|
|
151
|
+
* {@code ?lang=en&{query}}, the redirect URI is {@code http://host.com:8080/documents?lang=en}. The system
|
|
152
152
|
* truncates the final ampersand (&) because the incoming URI included no value to replace the {query} token.
|
|
153
153
|
* <p>
|
|
154
154
|
Examples:
|
|
155
|
-
* * **lang=en&time_zone=PST** appears as
|
|
155
|
+
* * **lang=en&time_zone=PST** appears as {@code lang=en&time_zone=PST} in the redirect URI.
|
|
156
156
|
* <p>
|
|
157
|
-
* **{query}** appears as
|
|
158
|
-
* string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the
|
|
157
|
+
* **{query}** appears as {@code lang=en&time_zone=PST} in the redirect URI if {@code lang=en&time_zone=PST} is the query
|
|
158
|
+
* string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the {@code {query}}
|
|
159
159
|
* token renders as an empty string.
|
|
160
160
|
* <p>
|
|
161
|
-
* **lang=en&{query}&time_zone=PST** appears as
|
|
162
|
-
*
|
|
163
|
-
* parameters, this value renders as
|
|
161
|
+
* **lang=en&{query}&time_zone=PST** appears as {@code lang=en&country=us&time_zone=PST} in the redirect URI if
|
|
162
|
+
* {@code country=us} is the query string in the incoming HTTP request. If the incoming HTTP request has no query
|
|
163
|
+
* parameters, this value renders as {@code lang=en&time_zone=PST}.
|
|
164
164
|
* <p>
|
|
165
|
-
* **protocol={protocol}&hostname={host}** appears as
|
|
166
|
-
* URI if the protocol is
|
|
165
|
+
* **protocol={protocol}&hostname={host}** appears as {@code protocol=http&hostname=example.com} in the redirect
|
|
166
|
+
* URI if the protocol is {@code HTTP} and the hostname is {@code example.com} in the incoming HTTP request.
|
|
167
167
|
* <p>
|
|
168
|
-
* **port={port}&hostname={host}** appears as
|
|
169
|
-
* port is
|
|
168
|
+
* **port={port}&hostname={host}** appears as {@code port=8080&hostname=example.com} in the redirect URI if the
|
|
169
|
+
* port is {@code 8080} and the hostname is {@code example.com} in the incoming HTTP request URI.
|
|
170
170
|
*
|
|
171
171
|
*/
|
|
172
172
|
"query"?: string;
|
|
@@ -17,7 +17,7 @@ import * as model from "../model";
|
|
|
17
17
|
* An object that represents the action of removing a header from a request. This rule applies only to HTTP listeners.
|
|
18
18
|
* If the same header appears more than once in the request, the load balancer removes all occurances of the specified header.
|
|
19
19
|
* **Note:** The system does not distinquish between underscore and dash characters in headers. That is, it treats
|
|
20
|
-
*
|
|
20
|
+
* {@code example_header_name} and {@code example-header-name} as identical. Oracle recommends that you do not rely on underscore
|
|
21
21
|
* or dash characters to uniquely distinguish header names.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
@@ -25,7 +25,7 @@ export interface RemoveHttpRequestHeaderRule extends model.Rule {
|
|
|
25
25
|
/**
|
|
26
26
|
* A header name that conforms to RFC 7230.
|
|
27
27
|
* <p>
|
|
28
|
-
Example:
|
|
28
|
+
Example: {@code example_header_name}
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
"header": string;
|
|
@@ -19,7 +19,7 @@ import * as model from "../model";
|
|
|
19
19
|
If the same header appears more than once in the response, the load balancer removes all occurances of the specified header.
|
|
20
20
|
* <p>
|
|
21
21
|
**Note:** The system does not distinquish between underscore and dash characters in headers. That is, it treats
|
|
22
|
-
*
|
|
22
|
+
* {@code example_header_name} and {@code example-header-name} as identical. Oracle recommends that you do not rely on underscore
|
|
23
23
|
* or dash characters to uniquely distinguish header names.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
@@ -27,7 +27,7 @@ export interface RemoveHttpResponseHeaderRule extends model.Rule {
|
|
|
27
27
|
/**
|
|
28
28
|
* A header name that conforms to RFC 7230.
|
|
29
29
|
* <p>
|
|
30
|
-
Example:
|
|
30
|
+
Example: {@code example_header_name}
|
|
31
31
|
*
|
|
32
32
|
*/
|
|
33
33
|
"header": string;
|
|
@@ -23,12 +23,12 @@ export interface RoutingPolicy {
|
|
|
23
23
|
/**
|
|
24
24
|
* The unique name for this list of routing rules. Avoid entering confidential information.
|
|
25
25
|
* <p>
|
|
26
|
-
Example:
|
|
26
|
+
Example: {@code example_routing_policy}
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
"name": string;
|
|
30
30
|
/**
|
|
31
|
-
* The version of the language in which
|
|
31
|
+
* The version of the language in which {@code condition} of {@code rules} are composed.
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
34
|
"conditionLanguageVersion": RoutingPolicy.ConditionLanguageVersion;
|
package/lib/model/rule-set.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ export interface RuleSet {
|
|
|
24
24
|
* The name for this set of rules. It must be unique and it cannot be changed. Avoid entering
|
|
25
25
|
* confidential information.
|
|
26
26
|
* <p>
|
|
27
|
-
Example:
|
|
27
|
+
Example: {@code example_rule_set}
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
"name": string;
|
|
@@ -195,7 +195,7 @@ export interface SSLCipherSuiteDetails {
|
|
|
195
195
|
* * oci-wider-compatible-ssl-cipher-suite-v1
|
|
196
196
|
* * oci-customized-ssl-cipher-suite
|
|
197
197
|
* <p>
|
|
198
|
-
example:
|
|
198
|
+
example: {@code example_cipher_suite}
|
|
199
199
|
*
|
|
200
200
|
*/
|
|
201
201
|
"name": string;
|
|
@@ -305,7 +305,7 @@ export interface SSLCipherSuiteDetails {
|
|
|
305
305
|
* \"RC4-SHA\"
|
|
306
306
|
* \"SEED-SHA\"
|
|
307
307
|
* <p>
|
|
308
|
-
example:
|
|
308
|
+
example: {@code [\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]}
|
|
309
309
|
*
|
|
310
310
|
*/
|
|
311
311
|
"ciphers": Array<string>;
|
|
@@ -195,7 +195,7 @@ export interface SSLCipherSuite {
|
|
|
195
195
|
* * oci-wider-compatible-ssl-cipher-suite-v1
|
|
196
196
|
* * oci-customized-ssl-cipher-suite
|
|
197
197
|
* <p>
|
|
198
|
-
example:
|
|
198
|
+
example: {@code example_cipher_suite}
|
|
199
199
|
*
|
|
200
200
|
*/
|
|
201
201
|
"name": string;
|
|
@@ -305,7 +305,7 @@ export interface SSLCipherSuite {
|
|
|
305
305
|
* \"RC4-SHA\"
|
|
306
306
|
* \"SEED-SHA\"
|
|
307
307
|
* <p>
|
|
308
|
-
example:
|
|
308
|
+
example: {@code [\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]}
|
|
309
309
|
*
|
|
310
310
|
*/
|
|
311
311
|
"ciphers": Array<string>;
|