ionoscloud 6.0.2 → 6.1.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/docs/CHANGELOG.md +8 -0
- data/docs/api/ApplicationLoadBalancersApi.md +1586 -0
- data/docs/api/TargetGroupsApi.md +516 -0
- data/docs/models/ApplicationLoadBalancer.md +28 -0
- data/docs/models/ApplicationLoadBalancerEntities.md +18 -0
- data/docs/models/ApplicationLoadBalancerForwardingRule.md +26 -0
- data/docs/models/ApplicationLoadBalancerForwardingRuleProperties.md +30 -0
- data/docs/models/ApplicationLoadBalancerForwardingRulePut.md +24 -0
- data/docs/models/ApplicationLoadBalancerForwardingRules.md +30 -0
- data/docs/models/ApplicationLoadBalancerHttpRule.md +34 -0
- data/docs/models/ApplicationLoadBalancerHttpRuleCondition.md +26 -0
- data/docs/models/ApplicationLoadBalancerProperties.md +26 -0
- data/docs/models/ApplicationLoadBalancerPut.md +24 -0
- data/docs/models/ApplicationLoadBalancers.md +30 -0
- data/docs/models/TargetGroup.md +26 -0
- data/docs/models/TargetGroupHealthCheck.md +22 -0
- data/docs/models/TargetGroupHttpHealthCheck.md +28 -0
- data/docs/models/TargetGroupProperties.md +28 -0
- data/docs/models/TargetGroupPut.md +24 -0
- data/docs/models/TargetGroupTarget.md +26 -0
- data/docs/models/TargetGroups.md +30 -0
- data/lib/ionoscloud/api/application_load_balancers_api.rb +1690 -0
- data/lib/ionoscloud/api/target_groups_api.rb +530 -0
- data/lib/ionoscloud/api_client.rb +1 -1
- data/lib/ionoscloud/models/application_load_balancer.rb +319 -0
- data/lib/ionoscloud/models/application_load_balancer_entities.rb +226 -0
- data/lib/ionoscloud/models/application_load_balancer_forwarding_rule.rb +302 -0
- data/lib/ionoscloud/models/application_load_balancer_forwarding_rule_properties.rb +389 -0
- data/lib/ionoscloud/models/application_load_balancer_forwarding_rule_put.rb +285 -0
- data/lib/ionoscloud/models/application_load_balancer_forwarding_rules.rb +334 -0
- data/lib/ionoscloud/models/application_load_balancer_http_rule.rb +427 -0
- data/lib/ionoscloud/models/application_load_balancer_http_rule_condition.rb +355 -0
- data/lib/ionoscloud/models/application_load_balancer_properties.rb +314 -0
- data/lib/ionoscloud/models/application_load_balancer_put.rb +285 -0
- data/lib/ionoscloud/models/application_load_balancers.rb +334 -0
- data/lib/ionoscloud/models/target_group.rb +302 -0
- data/lib/ionoscloud/models/target_group_health_check.rb +263 -0
- data/lib/ionoscloud/models/target_group_http_health_check.rb +373 -0
- data/lib/ionoscloud/models/target_group_properties.rb +376 -0
- data/lib/ionoscloud/models/target_group_put.rb +285 -0
- data/lib/ionoscloud/models/target_group_target.rb +314 -0
- data/lib/ionoscloud/models/target_groups.rb +334 -0
- data/lib/ionoscloud/version.rb +1 -1
- data/lib/ionoscloud.rb +20 -0
- metadata +42 -2
@@ -0,0 +1,1586 @@
|
|
1
|
+
# ApplicationLoadBalancersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_applicationloadbalancers_delete**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_delete) | **DELETE** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} | Delete Application Load Balancers |
|
8
|
+
| [**datacenters_applicationloadbalancers_find_by_application_load_balancer_id**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_find_by_application_load_balancer_id) | **GET** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} | Retrieve Application Load Balancers |
|
9
|
+
| [**datacenters_applicationloadbalancers_flowlogs_delete**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_delete) | **DELETE** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} | Delete ALB Flow Logs |
|
10
|
+
| [**datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id) | **GET** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} | Retrieve ALB Flow Logs |
|
11
|
+
| [**datacenters_applicationloadbalancers_flowlogs_get**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_get) | **GET** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs | List ALB Flow Logs |
|
12
|
+
| [**datacenters_applicationloadbalancers_flowlogs_patch**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_patch) | **PATCH** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} | Partially modify ALB Flow Logs |
|
13
|
+
| [**datacenters_applicationloadbalancers_flowlogs_post**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_post) | **POST** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs | Create ALB Flow Logs |
|
14
|
+
| [**datacenters_applicationloadbalancers_flowlogs_put**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_flowlogs_put) | **PUT** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} | Modify ALB Flow Logs |
|
15
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_delete**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_delete) | **DELETE** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} | Delete ALB forwarding rules |
|
16
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id) | **GET** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} | Retrieve ALB forwarding rules |
|
17
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_get**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_get) | **GET** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules | List ALB forwarding rules |
|
18
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_patch**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_patch) | **PATCH** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} | Partially modify ALB forwarding rules |
|
19
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_post**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_post) | **POST** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules | Create ALB forwarding rules |
|
20
|
+
| [**datacenters_applicationloadbalancers_forwardingrules_put**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_forwardingrules_put) | **PUT** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} | Modify ALB forwarding rules |
|
21
|
+
| [**datacenters_applicationloadbalancers_get**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_get) | **GET** /datacenters/{datacenterId}/applicationloadbalancers | List Application Load Balancers |
|
22
|
+
| [**datacenters_applicationloadbalancers_patch**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_patch) | **PATCH** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} | Partially modify Application Load Balancers |
|
23
|
+
| [**datacenters_applicationloadbalancers_post**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_post) | **POST** /datacenters/{datacenterId}/applicationloadbalancers | Create Application Load Balancers |
|
24
|
+
| [**datacenters_applicationloadbalancers_put**](ApplicationLoadBalancersApi.md#datacenters_applicationloadbalancers_put) | **PUT** /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} | Modify Application Load Balancers |
|
25
|
+
|
26
|
+
|
27
|
+
## datacenters_applicationloadbalancers_delete
|
28
|
+
|
29
|
+
> datacenters_applicationloadbalancers_delete(datacenter_id, application_load_balancer_id, opts)
|
30
|
+
|
31
|
+
Delete Application Load Balancers
|
32
|
+
|
33
|
+
Remove the specified Application Load Balancer from the data center..
|
34
|
+
|
35
|
+
### Examples
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
require 'time'
|
39
|
+
require 'ionoscloud'
|
40
|
+
# setup authorization
|
41
|
+
Ionoscloud.configure do |config|
|
42
|
+
# Configure HTTP basic authorization: Basic Authentication
|
43
|
+
config.username = 'YOUR USERNAME'
|
44
|
+
config.password = 'YOUR PASSWORD'
|
45
|
+
|
46
|
+
# Configure API key authorization: Token Authentication
|
47
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
48
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
49
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
50
|
+
end
|
51
|
+
|
52
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
53
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
54
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
55
|
+
opts = {
|
56
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
57
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
58
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
59
|
+
}
|
60
|
+
|
61
|
+
begin
|
62
|
+
# Delete Application Load Balancers
|
63
|
+
api_instance.datacenters_applicationloadbalancers_delete(datacenter_id, application_load_balancer_id, opts)
|
64
|
+
rescue Ionoscloud::ApiError => e
|
65
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_delete: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
#### Using the datacenters_applicationloadbalancers_delete_with_http_info variant
|
70
|
+
|
71
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
72
|
+
|
73
|
+
> <Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_delete_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
begin
|
77
|
+
# Delete Application Load Balancers
|
78
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_delete_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
79
|
+
p status_code # => 2xx
|
80
|
+
p headers # => { ... }
|
81
|
+
p data # => nil
|
82
|
+
rescue Ionoscloud::ApiError => e
|
83
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_delete_with_http_info: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
| Name | Type | Description | Notes |
|
90
|
+
| ---- | ---- | ----------- | ----- |
|
91
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
92
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
93
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
94
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
95
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
96
|
+
|
97
|
+
### Return type
|
98
|
+
|
99
|
+
nil (empty response body)
|
100
|
+
|
101
|
+
### Authorization
|
102
|
+
|
103
|
+
Basic Authentication, Token Authentication
|
104
|
+
|
105
|
+
### HTTP request headers
|
106
|
+
|
107
|
+
- **Content-Type**: Not defined
|
108
|
+
- **Accept**: application/json
|
109
|
+
|
110
|
+
|
111
|
+
## datacenters_applicationloadbalancers_find_by_application_load_balancer_id
|
112
|
+
|
113
|
+
> <ApplicationLoadBalancer> datacenters_applicationloadbalancers_find_by_application_load_balancer_id(datacenter_id, application_load_balancer_id, opts)
|
114
|
+
|
115
|
+
Retrieve Application Load Balancers
|
116
|
+
|
117
|
+
Retrieve the properties of the specified Application Load Balancer within the data center.
|
118
|
+
|
119
|
+
### Examples
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
require 'time'
|
123
|
+
require 'ionoscloud'
|
124
|
+
# setup authorization
|
125
|
+
Ionoscloud.configure do |config|
|
126
|
+
# Configure HTTP basic authorization: Basic Authentication
|
127
|
+
config.username = 'YOUR USERNAME'
|
128
|
+
config.password = 'YOUR PASSWORD'
|
129
|
+
|
130
|
+
# Configure API key authorization: Token Authentication
|
131
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
133
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
134
|
+
end
|
135
|
+
|
136
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
137
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
138
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
139
|
+
opts = {
|
140
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
141
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
142
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
143
|
+
}
|
144
|
+
|
145
|
+
begin
|
146
|
+
# Retrieve Application Load Balancers
|
147
|
+
result = api_instance.datacenters_applicationloadbalancers_find_by_application_load_balancer_id(datacenter_id, application_load_balancer_id, opts)
|
148
|
+
p result
|
149
|
+
rescue Ionoscloud::ApiError => e
|
150
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_find_by_application_load_balancer_id: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
#### Using the datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info variant
|
155
|
+
|
156
|
+
This returns an Array which contains the response data, status code and headers.
|
157
|
+
|
158
|
+
> <Array(<ApplicationLoadBalancer>, Integer, Hash)> datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
159
|
+
|
160
|
+
```ruby
|
161
|
+
begin
|
162
|
+
# Retrieve Application Load Balancers
|
163
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
164
|
+
p status_code # => 2xx
|
165
|
+
p headers # => { ... }
|
166
|
+
p data # => <ApplicationLoadBalancer>
|
167
|
+
rescue Ionoscloud::ApiError => e
|
168
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info: #{e}"
|
169
|
+
end
|
170
|
+
```
|
171
|
+
|
172
|
+
### Parameters
|
173
|
+
|
174
|
+
| Name | Type | Description | Notes |
|
175
|
+
| ---- | ---- | ----------- | ----- |
|
176
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
177
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
178
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
179
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
180
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**ApplicationLoadBalancer**](../models/ApplicationLoadBalancer.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
Basic Authentication, Token Authentication
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: Not defined
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
## datacenters_applicationloadbalancers_flowlogs_delete
|
197
|
+
|
198
|
+
> datacenters_applicationloadbalancers_flowlogs_delete(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
199
|
+
|
200
|
+
Delete ALB Flow Logs
|
201
|
+
|
202
|
+
Delete the specified Application Load Balancer Flow Log.
|
203
|
+
|
204
|
+
### Examples
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
require 'time'
|
208
|
+
require 'ionoscloud'
|
209
|
+
# setup authorization
|
210
|
+
Ionoscloud.configure do |config|
|
211
|
+
# Configure HTTP basic authorization: Basic Authentication
|
212
|
+
config.username = 'YOUR USERNAME'
|
213
|
+
config.password = 'YOUR PASSWORD'
|
214
|
+
|
215
|
+
# Configure API key authorization: Token Authentication
|
216
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
217
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
218
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
219
|
+
end
|
220
|
+
|
221
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
222
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
223
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
224
|
+
flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
|
225
|
+
opts = {
|
226
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
227
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
228
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
229
|
+
}
|
230
|
+
|
231
|
+
begin
|
232
|
+
# Delete ALB Flow Logs
|
233
|
+
api_instance.datacenters_applicationloadbalancers_flowlogs_delete(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
234
|
+
rescue Ionoscloud::ApiError => e
|
235
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_delete: #{e}"
|
236
|
+
end
|
237
|
+
```
|
238
|
+
|
239
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_delete_with_http_info variant
|
240
|
+
|
241
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
242
|
+
|
243
|
+
> <Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_delete_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
begin
|
247
|
+
# Delete ALB Flow Logs
|
248
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_delete_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
249
|
+
p status_code # => 2xx
|
250
|
+
p headers # => { ... }
|
251
|
+
p data # => nil
|
252
|
+
rescue Ionoscloud::ApiError => e
|
253
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_delete_with_http_info: #{e}"
|
254
|
+
end
|
255
|
+
```
|
256
|
+
|
257
|
+
### Parameters
|
258
|
+
|
259
|
+
| Name | Type | Description | Notes |
|
260
|
+
| ---- | ---- | ----------- | ----- |
|
261
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
262
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
263
|
+
| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
|
264
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
265
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
266
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
nil (empty response body)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
Basic Authentication, Token Authentication
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: Not defined
|
279
|
+
- **Accept**: application/json
|
280
|
+
|
281
|
+
|
282
|
+
## datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id
|
283
|
+
|
284
|
+
> <FlowLog> datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
285
|
+
|
286
|
+
Retrieve ALB Flow Logs
|
287
|
+
|
288
|
+
Retrieve the specified Application Load Balancer Flow Log.
|
289
|
+
|
290
|
+
### Examples
|
291
|
+
|
292
|
+
```ruby
|
293
|
+
require 'time'
|
294
|
+
require 'ionoscloud'
|
295
|
+
# setup authorization
|
296
|
+
Ionoscloud.configure do |config|
|
297
|
+
# Configure HTTP basic authorization: Basic Authentication
|
298
|
+
config.username = 'YOUR USERNAME'
|
299
|
+
config.password = 'YOUR PASSWORD'
|
300
|
+
|
301
|
+
# Configure API key authorization: Token Authentication
|
302
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
303
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
304
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
308
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
309
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
310
|
+
flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
|
311
|
+
opts = {
|
312
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
313
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
314
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
315
|
+
}
|
316
|
+
|
317
|
+
begin
|
318
|
+
# Retrieve ALB Flow Logs
|
319
|
+
result = api_instance.datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
320
|
+
p result
|
321
|
+
rescue Ionoscloud::ApiError => e
|
322
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id: #{e}"
|
323
|
+
end
|
324
|
+
```
|
325
|
+
|
326
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info variant
|
327
|
+
|
328
|
+
This returns an Array which contains the response data, status code and headers.
|
329
|
+
|
330
|
+
> <Array(<FlowLog>, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
331
|
+
|
332
|
+
```ruby
|
333
|
+
begin
|
334
|
+
# Retrieve ALB Flow Logs
|
335
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
|
336
|
+
p status_code # => 2xx
|
337
|
+
p headers # => { ... }
|
338
|
+
p data # => <FlowLog>
|
339
|
+
rescue Ionoscloud::ApiError => e
|
340
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info: #{e}"
|
341
|
+
end
|
342
|
+
```
|
343
|
+
|
344
|
+
### Parameters
|
345
|
+
|
346
|
+
| Name | Type | Description | Notes |
|
347
|
+
| ---- | ---- | ----------- | ----- |
|
348
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
349
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
350
|
+
| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
|
351
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
352
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
353
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
354
|
+
|
355
|
+
### Return type
|
356
|
+
|
357
|
+
[**FlowLog**](../models/FlowLog.md)
|
358
|
+
|
359
|
+
### Authorization
|
360
|
+
|
361
|
+
Basic Authentication, Token Authentication
|
362
|
+
|
363
|
+
### HTTP request headers
|
364
|
+
|
365
|
+
- **Content-Type**: Not defined
|
366
|
+
- **Accept**: application/json
|
367
|
+
|
368
|
+
|
369
|
+
## datacenters_applicationloadbalancers_flowlogs_get
|
370
|
+
|
371
|
+
> <FlowLogs> datacenters_applicationloadbalancers_flowlogs_get(datacenter_id, application_load_balancer_id, opts)
|
372
|
+
|
373
|
+
List ALB Flow Logs
|
374
|
+
|
375
|
+
List the Flow Logs for the specified Application Load Balancer.
|
376
|
+
|
377
|
+
### Examples
|
378
|
+
|
379
|
+
```ruby
|
380
|
+
require 'time'
|
381
|
+
require 'ionoscloud'
|
382
|
+
# setup authorization
|
383
|
+
Ionoscloud.configure do |config|
|
384
|
+
# Configure HTTP basic authorization: Basic Authentication
|
385
|
+
config.username = 'YOUR USERNAME'
|
386
|
+
config.password = 'YOUR PASSWORD'
|
387
|
+
|
388
|
+
# Configure API key authorization: Token Authentication
|
389
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
390
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
391
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
392
|
+
end
|
393
|
+
|
394
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
395
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
396
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
397
|
+
opts = {
|
398
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
399
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
400
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
401
|
+
}
|
402
|
+
|
403
|
+
begin
|
404
|
+
# List ALB Flow Logs
|
405
|
+
result = api_instance.datacenters_applicationloadbalancers_flowlogs_get(datacenter_id, application_load_balancer_id, opts)
|
406
|
+
p result
|
407
|
+
rescue Ionoscloud::ApiError => e
|
408
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_get: #{e}"
|
409
|
+
end
|
410
|
+
```
|
411
|
+
|
412
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_get_with_http_info variant
|
413
|
+
|
414
|
+
This returns an Array which contains the response data, status code and headers.
|
415
|
+
|
416
|
+
> <Array(<FlowLogs>, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
417
|
+
|
418
|
+
```ruby
|
419
|
+
begin
|
420
|
+
# List ALB Flow Logs
|
421
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
422
|
+
p status_code # => 2xx
|
423
|
+
p headers # => { ... }
|
424
|
+
p data # => <FlowLogs>
|
425
|
+
rescue Ionoscloud::ApiError => e
|
426
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_get_with_http_info: #{e}"
|
427
|
+
end
|
428
|
+
```
|
429
|
+
|
430
|
+
### Parameters
|
431
|
+
|
432
|
+
| Name | Type | Description | Notes |
|
433
|
+
| ---- | ---- | ----------- | ----- |
|
434
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
435
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
436
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
437
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
438
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**FlowLogs**](../models/FlowLogs.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
Basic Authentication, Token Authentication
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
## datacenters_applicationloadbalancers_flowlogs_patch
|
455
|
+
|
456
|
+
> <FlowLog> datacenters_applicationloadbalancers_flowlogs_patch(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
|
457
|
+
|
458
|
+
Partially modify ALB Flow Logs
|
459
|
+
|
460
|
+
Update the properties of the specified Application Load Balancer Flow Log.
|
461
|
+
|
462
|
+
### Examples
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
require 'time'
|
466
|
+
require 'ionoscloud'
|
467
|
+
# setup authorization
|
468
|
+
Ionoscloud.configure do |config|
|
469
|
+
# Configure HTTP basic authorization: Basic Authentication
|
470
|
+
config.username = 'YOUR USERNAME'
|
471
|
+
config.password = 'YOUR PASSWORD'
|
472
|
+
|
473
|
+
# Configure API key authorization: Token Authentication
|
474
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
476
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
480
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
481
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
482
|
+
flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
|
483
|
+
application_load_balancer_flow_log_properties = Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'}) # FlowLogProperties | The properties of the ALB Flow Log to be updated.
|
484
|
+
opts = {
|
485
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
486
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
487
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
488
|
+
}
|
489
|
+
|
490
|
+
begin
|
491
|
+
# Partially modify ALB Flow Logs
|
492
|
+
result = api_instance.datacenters_applicationloadbalancers_flowlogs_patch(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
|
493
|
+
p result
|
494
|
+
rescue Ionoscloud::ApiError => e
|
495
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_patch: #{e}"
|
496
|
+
end
|
497
|
+
```
|
498
|
+
|
499
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_patch_with_http_info variant
|
500
|
+
|
501
|
+
This returns an Array which contains the response data, status code and headers.
|
502
|
+
|
503
|
+
> <Array(<FlowLog>, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_patch_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
|
504
|
+
|
505
|
+
```ruby
|
506
|
+
begin
|
507
|
+
# Partially modify ALB Flow Logs
|
508
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_patch_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
|
509
|
+
p status_code # => 2xx
|
510
|
+
p headers # => { ... }
|
511
|
+
p data # => <FlowLog>
|
512
|
+
rescue Ionoscloud::ApiError => e
|
513
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_patch_with_http_info: #{e}"
|
514
|
+
end
|
515
|
+
```
|
516
|
+
|
517
|
+
### Parameters
|
518
|
+
|
519
|
+
| Name | Type | Description | Notes |
|
520
|
+
| ---- | ---- | ----------- | ----- |
|
521
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
522
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
523
|
+
| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
|
524
|
+
| **application_load_balancer_flow_log_properties** | [**FlowLogProperties**](FlowLogProperties.md) | The properties of the ALB Flow Log to be updated. | |
|
525
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
526
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
527
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
528
|
+
|
529
|
+
### Return type
|
530
|
+
|
531
|
+
[**FlowLog**](../models/FlowLog.md)
|
532
|
+
|
533
|
+
### Authorization
|
534
|
+
|
535
|
+
Basic Authentication, Token Authentication
|
536
|
+
|
537
|
+
### HTTP request headers
|
538
|
+
|
539
|
+
- **Content-Type**: Not defined
|
540
|
+
- **Accept**: application/json
|
541
|
+
|
542
|
+
|
543
|
+
## datacenters_applicationloadbalancers_flowlogs_post
|
544
|
+
|
545
|
+
> <FlowLog> datacenters_applicationloadbalancers_flowlogs_post(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
|
546
|
+
|
547
|
+
Create ALB Flow Logs
|
548
|
+
|
549
|
+
Add a new Flow Log for the Application Load Balancer.
|
550
|
+
|
551
|
+
### Examples
|
552
|
+
|
553
|
+
```ruby
|
554
|
+
require 'time'
|
555
|
+
require 'ionoscloud'
|
556
|
+
# setup authorization
|
557
|
+
Ionoscloud.configure do |config|
|
558
|
+
# Configure HTTP basic authorization: Basic Authentication
|
559
|
+
config.username = 'YOUR USERNAME'
|
560
|
+
config.password = 'YOUR PASSWORD'
|
561
|
+
|
562
|
+
# Configure API key authorization: Token Authentication
|
563
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
564
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
565
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
566
|
+
end
|
567
|
+
|
568
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
569
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
570
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
571
|
+
application_load_balancer_flow_log = Ionoscloud::FlowLog.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLog | The Flow Log to create.
|
572
|
+
opts = {
|
573
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
574
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
575
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
576
|
+
}
|
577
|
+
|
578
|
+
begin
|
579
|
+
# Create ALB Flow Logs
|
580
|
+
result = api_instance.datacenters_applicationloadbalancers_flowlogs_post(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
|
581
|
+
p result
|
582
|
+
rescue Ionoscloud::ApiError => e
|
583
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_post: #{e}"
|
584
|
+
end
|
585
|
+
```
|
586
|
+
|
587
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_post_with_http_info variant
|
588
|
+
|
589
|
+
This returns an Array which contains the response data, status code and headers.
|
590
|
+
|
591
|
+
> <Array(<FlowLog>, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
|
592
|
+
|
593
|
+
```ruby
|
594
|
+
begin
|
595
|
+
# Create ALB Flow Logs
|
596
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
|
597
|
+
p status_code # => 2xx
|
598
|
+
p headers # => { ... }
|
599
|
+
p data # => <FlowLog>
|
600
|
+
rescue Ionoscloud::ApiError => e
|
601
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_post_with_http_info: #{e}"
|
602
|
+
end
|
603
|
+
```
|
604
|
+
|
605
|
+
### Parameters
|
606
|
+
|
607
|
+
| Name | Type | Description | Notes |
|
608
|
+
| ---- | ---- | ----------- | ----- |
|
609
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
610
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
611
|
+
| **application_load_balancer_flow_log** | [**FlowLog**](FlowLog.md) | The Flow Log to create. | |
|
612
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
613
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
614
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
615
|
+
|
616
|
+
### Return type
|
617
|
+
|
618
|
+
[**FlowLog**](../models/FlowLog.md)
|
619
|
+
|
620
|
+
### Authorization
|
621
|
+
|
622
|
+
Basic Authentication, Token Authentication
|
623
|
+
|
624
|
+
### HTTP request headers
|
625
|
+
|
626
|
+
- **Content-Type**: application/json
|
627
|
+
- **Accept**: application/json
|
628
|
+
|
629
|
+
|
630
|
+
## datacenters_applicationloadbalancers_flowlogs_put
|
631
|
+
|
632
|
+
> <FlowLog> datacenters_applicationloadbalancers_flowlogs_put(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
|
633
|
+
|
634
|
+
Modify ALB Flow Logs
|
635
|
+
|
636
|
+
Modify the specified Application Load Balancer Flow Log.
|
637
|
+
|
638
|
+
### Examples
|
639
|
+
|
640
|
+
```ruby
|
641
|
+
require 'time'
|
642
|
+
require 'ionoscloud'
|
643
|
+
# setup authorization
|
644
|
+
Ionoscloud.configure do |config|
|
645
|
+
# Configure HTTP basic authorization: Basic Authentication
|
646
|
+
config.username = 'YOUR USERNAME'
|
647
|
+
config.password = 'YOUR PASSWORD'
|
648
|
+
|
649
|
+
# Configure API key authorization: Token Authentication
|
650
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
651
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
652
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
653
|
+
end
|
654
|
+
|
655
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
656
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
657
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
658
|
+
flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
|
659
|
+
application_load_balancer_flow_log = Ionoscloud::FlowLogPut.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLogPut | The modified ALB Flow Log.
|
660
|
+
opts = {
|
661
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
662
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
663
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
664
|
+
}
|
665
|
+
|
666
|
+
begin
|
667
|
+
# Modify ALB Flow Logs
|
668
|
+
result = api_instance.datacenters_applicationloadbalancers_flowlogs_put(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
|
669
|
+
p result
|
670
|
+
rescue Ionoscloud::ApiError => e
|
671
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_put: #{e}"
|
672
|
+
end
|
673
|
+
```
|
674
|
+
|
675
|
+
#### Using the datacenters_applicationloadbalancers_flowlogs_put_with_http_info variant
|
676
|
+
|
677
|
+
This returns an Array which contains the response data, status code and headers.
|
678
|
+
|
679
|
+
> <Array(<FlowLog>, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_put_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
|
680
|
+
|
681
|
+
```ruby
|
682
|
+
begin
|
683
|
+
# Modify ALB Flow Logs
|
684
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_put_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
|
685
|
+
p status_code # => 2xx
|
686
|
+
p headers # => { ... }
|
687
|
+
p data # => <FlowLog>
|
688
|
+
rescue Ionoscloud::ApiError => e
|
689
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_put_with_http_info: #{e}"
|
690
|
+
end
|
691
|
+
```
|
692
|
+
|
693
|
+
### Parameters
|
694
|
+
|
695
|
+
| Name | Type | Description | Notes |
|
696
|
+
| ---- | ---- | ----------- | ----- |
|
697
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
698
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
699
|
+
| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
|
700
|
+
| **application_load_balancer_flow_log** | [**FlowLogPut**](FlowLogPut.md) | The modified ALB Flow Log. | |
|
701
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
702
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
703
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
704
|
+
|
705
|
+
### Return type
|
706
|
+
|
707
|
+
[**FlowLog**](../models/FlowLog.md)
|
708
|
+
|
709
|
+
### Authorization
|
710
|
+
|
711
|
+
Basic Authentication, Token Authentication
|
712
|
+
|
713
|
+
### HTTP request headers
|
714
|
+
|
715
|
+
- **Content-Type**: application/json
|
716
|
+
- **Accept**: application/json
|
717
|
+
|
718
|
+
|
719
|
+
## datacenters_applicationloadbalancers_forwardingrules_delete
|
720
|
+
|
721
|
+
> datacenters_applicationloadbalancers_forwardingrules_delete(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
722
|
+
|
723
|
+
Delete ALB forwarding rules
|
724
|
+
|
725
|
+
Delete the specified Application Load Balancer forwarding rule.
|
726
|
+
|
727
|
+
### Examples
|
728
|
+
|
729
|
+
```ruby
|
730
|
+
require 'time'
|
731
|
+
require 'ionoscloud'
|
732
|
+
# setup authorization
|
733
|
+
Ionoscloud.configure do |config|
|
734
|
+
# Configure HTTP basic authorization: Basic Authentication
|
735
|
+
config.username = 'YOUR USERNAME'
|
736
|
+
config.password = 'YOUR PASSWORD'
|
737
|
+
|
738
|
+
# Configure API key authorization: Token Authentication
|
739
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
740
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
741
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
742
|
+
end
|
743
|
+
|
744
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
745
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
746
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
747
|
+
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
|
748
|
+
opts = {
|
749
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
750
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
751
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
752
|
+
}
|
753
|
+
|
754
|
+
begin
|
755
|
+
# Delete ALB forwarding rules
|
756
|
+
api_instance.datacenters_applicationloadbalancers_forwardingrules_delete(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
757
|
+
rescue Ionoscloud::ApiError => e
|
758
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_delete: #{e}"
|
759
|
+
end
|
760
|
+
```
|
761
|
+
|
762
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info variant
|
763
|
+
|
764
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
765
|
+
|
766
|
+
> <Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
767
|
+
|
768
|
+
```ruby
|
769
|
+
begin
|
770
|
+
# Delete ALB forwarding rules
|
771
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
772
|
+
p status_code # => 2xx
|
773
|
+
p headers # => { ... }
|
774
|
+
p data # => nil
|
775
|
+
rescue Ionoscloud::ApiError => e
|
776
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info: #{e}"
|
777
|
+
end
|
778
|
+
```
|
779
|
+
|
780
|
+
### Parameters
|
781
|
+
|
782
|
+
| Name | Type | Description | Notes |
|
783
|
+
| ---- | ---- | ----------- | ----- |
|
784
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
785
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
786
|
+
| **forwarding_rule_id** | **String** | The unique ID of the forwarding rule. | |
|
787
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
788
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
789
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
790
|
+
|
791
|
+
### Return type
|
792
|
+
|
793
|
+
nil (empty response body)
|
794
|
+
|
795
|
+
### Authorization
|
796
|
+
|
797
|
+
Basic Authentication, Token Authentication
|
798
|
+
|
799
|
+
### HTTP request headers
|
800
|
+
|
801
|
+
- **Content-Type**: Not defined
|
802
|
+
- **Accept**: application/json
|
803
|
+
|
804
|
+
|
805
|
+
## datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id
|
806
|
+
|
807
|
+
> <ApplicationLoadBalancerForwardingRule> datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
808
|
+
|
809
|
+
Retrieve ALB forwarding rules
|
810
|
+
|
811
|
+
Retrieve the specified Application Load Balancer forwarding rule.
|
812
|
+
|
813
|
+
### Examples
|
814
|
+
|
815
|
+
```ruby
|
816
|
+
require 'time'
|
817
|
+
require 'ionoscloud'
|
818
|
+
# setup authorization
|
819
|
+
Ionoscloud.configure do |config|
|
820
|
+
# Configure HTTP basic authorization: Basic Authentication
|
821
|
+
config.username = 'YOUR USERNAME'
|
822
|
+
config.password = 'YOUR PASSWORD'
|
823
|
+
|
824
|
+
# Configure API key authorization: Token Authentication
|
825
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
826
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
827
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
828
|
+
end
|
829
|
+
|
830
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
831
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
832
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
833
|
+
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
|
834
|
+
opts = {
|
835
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
836
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
837
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
838
|
+
}
|
839
|
+
|
840
|
+
begin
|
841
|
+
# Retrieve ALB forwarding rules
|
842
|
+
result = api_instance.datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
843
|
+
p result
|
844
|
+
rescue Ionoscloud::ApiError => e
|
845
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id: #{e}"
|
846
|
+
end
|
847
|
+
```
|
848
|
+
|
849
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info variant
|
850
|
+
|
851
|
+
This returns an Array which contains the response data, status code and headers.
|
852
|
+
|
853
|
+
> <Array(<ApplicationLoadBalancerForwardingRule>, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
854
|
+
|
855
|
+
```ruby
|
856
|
+
begin
|
857
|
+
# Retrieve ALB forwarding rules
|
858
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
|
859
|
+
p status_code # => 2xx
|
860
|
+
p headers # => { ... }
|
861
|
+
p data # => <ApplicationLoadBalancerForwardingRule>
|
862
|
+
rescue Ionoscloud::ApiError => e
|
863
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info: #{e}"
|
864
|
+
end
|
865
|
+
```
|
866
|
+
|
867
|
+
### Parameters
|
868
|
+
|
869
|
+
| Name | Type | Description | Notes |
|
870
|
+
| ---- | ---- | ----------- | ----- |
|
871
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
872
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
873
|
+
| **forwarding_rule_id** | **String** | The unique ID of the forwarding rule. | |
|
874
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
875
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
876
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
877
|
+
|
878
|
+
### Return type
|
879
|
+
|
880
|
+
[**ApplicationLoadBalancerForwardingRule**](../models/ApplicationLoadBalancerForwardingRule.md)
|
881
|
+
|
882
|
+
### Authorization
|
883
|
+
|
884
|
+
Basic Authentication, Token Authentication
|
885
|
+
|
886
|
+
### HTTP request headers
|
887
|
+
|
888
|
+
- **Content-Type**: Not defined
|
889
|
+
- **Accept**: application/json
|
890
|
+
|
891
|
+
|
892
|
+
## datacenters_applicationloadbalancers_forwardingrules_get
|
893
|
+
|
894
|
+
> <ApplicationLoadBalancerForwardingRules> datacenters_applicationloadbalancers_forwardingrules_get(datacenter_id, application_load_balancer_id, opts)
|
895
|
+
|
896
|
+
List ALB forwarding rules
|
897
|
+
|
898
|
+
List the forwarding rules for the specified Application Load Balancer.
|
899
|
+
|
900
|
+
### Examples
|
901
|
+
|
902
|
+
```ruby
|
903
|
+
require 'time'
|
904
|
+
require 'ionoscloud'
|
905
|
+
# setup authorization
|
906
|
+
Ionoscloud.configure do |config|
|
907
|
+
# Configure HTTP basic authorization: Basic Authentication
|
908
|
+
config.username = 'YOUR USERNAME'
|
909
|
+
config.password = 'YOUR PASSWORD'
|
910
|
+
|
911
|
+
# Configure API key authorization: Token Authentication
|
912
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
913
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
914
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
915
|
+
end
|
916
|
+
|
917
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
918
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
919
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
920
|
+
opts = {
|
921
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
922
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
923
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
924
|
+
}
|
925
|
+
|
926
|
+
begin
|
927
|
+
# List ALB forwarding rules
|
928
|
+
result = api_instance.datacenters_applicationloadbalancers_forwardingrules_get(datacenter_id, application_load_balancer_id, opts)
|
929
|
+
p result
|
930
|
+
rescue Ionoscloud::ApiError => e
|
931
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_get: #{e}"
|
932
|
+
end
|
933
|
+
```
|
934
|
+
|
935
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_get_with_http_info variant
|
936
|
+
|
937
|
+
This returns an Array which contains the response data, status code and headers.
|
938
|
+
|
939
|
+
> <Array(<ApplicationLoadBalancerForwardingRules>, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
940
|
+
|
941
|
+
```ruby
|
942
|
+
begin
|
943
|
+
# List ALB forwarding rules
|
944
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
|
945
|
+
p status_code # => 2xx
|
946
|
+
p headers # => { ... }
|
947
|
+
p data # => <ApplicationLoadBalancerForwardingRules>
|
948
|
+
rescue Ionoscloud::ApiError => e
|
949
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_get_with_http_info: #{e}"
|
950
|
+
end
|
951
|
+
```
|
952
|
+
|
953
|
+
### Parameters
|
954
|
+
|
955
|
+
| Name | Type | Description | Notes |
|
956
|
+
| ---- | ---- | ----------- | ----- |
|
957
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
958
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
959
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
960
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
961
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
962
|
+
|
963
|
+
### Return type
|
964
|
+
|
965
|
+
[**ApplicationLoadBalancerForwardingRules**](../models/ApplicationLoadBalancerForwardingRules.md)
|
966
|
+
|
967
|
+
### Authorization
|
968
|
+
|
969
|
+
Basic Authentication, Token Authentication
|
970
|
+
|
971
|
+
### HTTP request headers
|
972
|
+
|
973
|
+
- **Content-Type**: Not defined
|
974
|
+
- **Accept**: application/json
|
975
|
+
|
976
|
+
|
977
|
+
## datacenters_applicationloadbalancers_forwardingrules_patch
|
978
|
+
|
979
|
+
> <ApplicationLoadBalancerForwardingRule> datacenters_applicationloadbalancers_forwardingrules_patch(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
|
980
|
+
|
981
|
+
Partially modify ALB forwarding rules
|
982
|
+
|
983
|
+
Update the properties of the specified Application Load Balancer forwarding rule.
|
984
|
+
|
985
|
+
### Examples
|
986
|
+
|
987
|
+
```ruby
|
988
|
+
require 'time'
|
989
|
+
require 'ionoscloud'
|
990
|
+
# setup authorization
|
991
|
+
Ionoscloud.configure do |config|
|
992
|
+
# Configure HTTP basic authorization: Basic Authentication
|
993
|
+
config.username = 'YOUR USERNAME'
|
994
|
+
config.password = 'YOUR PASSWORD'
|
995
|
+
|
996
|
+
# Configure API key authorization: Token Authentication
|
997
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
998
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
999
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1003
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1004
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
1005
|
+
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
|
1006
|
+
application_load_balancer_forwarding_rule_properties = Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP', listener_ip: '81.173.1.2', listener_port: 8080}) # ApplicationLoadBalancerForwardingRuleProperties | The properties of the forwarding rule to be updated.
|
1007
|
+
opts = {
|
1008
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1009
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1010
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1011
|
+
}
|
1012
|
+
|
1013
|
+
begin
|
1014
|
+
# Partially modify ALB forwarding rules
|
1015
|
+
result = api_instance.datacenters_applicationloadbalancers_forwardingrules_patch(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
|
1016
|
+
p result
|
1017
|
+
rescue Ionoscloud::ApiError => e
|
1018
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_patch: #{e}"
|
1019
|
+
end
|
1020
|
+
```
|
1021
|
+
|
1022
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info variant
|
1023
|
+
|
1024
|
+
This returns an Array which contains the response data, status code and headers.
|
1025
|
+
|
1026
|
+
> <Array(<ApplicationLoadBalancerForwardingRule>, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
|
1027
|
+
|
1028
|
+
```ruby
|
1029
|
+
begin
|
1030
|
+
# Partially modify ALB forwarding rules
|
1031
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
|
1032
|
+
p status_code # => 2xx
|
1033
|
+
p headers # => { ... }
|
1034
|
+
p data # => <ApplicationLoadBalancerForwardingRule>
|
1035
|
+
rescue Ionoscloud::ApiError => e
|
1036
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info: #{e}"
|
1037
|
+
end
|
1038
|
+
```
|
1039
|
+
|
1040
|
+
### Parameters
|
1041
|
+
|
1042
|
+
| Name | Type | Description | Notes |
|
1043
|
+
| ---- | ---- | ----------- | ----- |
|
1044
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1045
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
1046
|
+
| **forwarding_rule_id** | **String** | The unique ID of the forwarding rule. | |
|
1047
|
+
| **application_load_balancer_forwarding_rule_properties** | [**ApplicationLoadBalancerForwardingRuleProperties**](ApplicationLoadBalancerForwardingRuleProperties.md) | The properties of the forwarding rule to be updated. | |
|
1048
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1049
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1050
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1051
|
+
|
1052
|
+
### Return type
|
1053
|
+
|
1054
|
+
[**ApplicationLoadBalancerForwardingRule**](../models/ApplicationLoadBalancerForwardingRule.md)
|
1055
|
+
|
1056
|
+
### Authorization
|
1057
|
+
|
1058
|
+
Basic Authentication, Token Authentication
|
1059
|
+
|
1060
|
+
### HTTP request headers
|
1061
|
+
|
1062
|
+
- **Content-Type**: Not defined
|
1063
|
+
- **Accept**: application/json
|
1064
|
+
|
1065
|
+
|
1066
|
+
## datacenters_applicationloadbalancers_forwardingrules_post
|
1067
|
+
|
1068
|
+
> <ApplicationLoadBalancerForwardingRule> datacenters_applicationloadbalancers_forwardingrules_post(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
|
1069
|
+
|
1070
|
+
Create ALB forwarding rules
|
1071
|
+
|
1072
|
+
Create a forwarding rule for the Application Load Balancer.
|
1073
|
+
|
1074
|
+
### Examples
|
1075
|
+
|
1076
|
+
```ruby
|
1077
|
+
require 'time'
|
1078
|
+
require 'ionoscloud'
|
1079
|
+
# setup authorization
|
1080
|
+
Ionoscloud.configure do |config|
|
1081
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1082
|
+
config.username = 'YOUR USERNAME'
|
1083
|
+
config.password = 'YOUR PASSWORD'
|
1084
|
+
|
1085
|
+
# Configure API key authorization: Token Authentication
|
1086
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1087
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1088
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1092
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1093
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
1094
|
+
application_load_balancer_forwarding_rule = Ionoscloud::ApplicationLoadBalancerForwardingRule.new({properties: Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP', listener_ip: '81.173.1.2', listener_port: 8080})}) # ApplicationLoadBalancerForwardingRule | The forwarding rule to create.
|
1095
|
+
opts = {
|
1096
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1097
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1098
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1099
|
+
}
|
1100
|
+
|
1101
|
+
begin
|
1102
|
+
# Create ALB forwarding rules
|
1103
|
+
result = api_instance.datacenters_applicationloadbalancers_forwardingrules_post(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
|
1104
|
+
p result
|
1105
|
+
rescue Ionoscloud::ApiError => e
|
1106
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_post: #{e}"
|
1107
|
+
end
|
1108
|
+
```
|
1109
|
+
|
1110
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_post_with_http_info variant
|
1111
|
+
|
1112
|
+
This returns an Array which contains the response data, status code and headers.
|
1113
|
+
|
1114
|
+
> <Array(<ApplicationLoadBalancerForwardingRule>, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
|
1115
|
+
|
1116
|
+
```ruby
|
1117
|
+
begin
|
1118
|
+
# Create ALB forwarding rules
|
1119
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
|
1120
|
+
p status_code # => 2xx
|
1121
|
+
p headers # => { ... }
|
1122
|
+
p data # => <ApplicationLoadBalancerForwardingRule>
|
1123
|
+
rescue Ionoscloud::ApiError => e
|
1124
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_post_with_http_info: #{e}"
|
1125
|
+
end
|
1126
|
+
```
|
1127
|
+
|
1128
|
+
### Parameters
|
1129
|
+
|
1130
|
+
| Name | Type | Description | Notes |
|
1131
|
+
| ---- | ---- | ----------- | ----- |
|
1132
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1133
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
1134
|
+
| **application_load_balancer_forwarding_rule** | [**ApplicationLoadBalancerForwardingRule**](ApplicationLoadBalancerForwardingRule.md) | The forwarding rule to create. | |
|
1135
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1136
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1137
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1138
|
+
|
1139
|
+
### Return type
|
1140
|
+
|
1141
|
+
[**ApplicationLoadBalancerForwardingRule**](../models/ApplicationLoadBalancerForwardingRule.md)
|
1142
|
+
|
1143
|
+
### Authorization
|
1144
|
+
|
1145
|
+
Basic Authentication, Token Authentication
|
1146
|
+
|
1147
|
+
### HTTP request headers
|
1148
|
+
|
1149
|
+
- **Content-Type**: application/json
|
1150
|
+
- **Accept**: application/json
|
1151
|
+
|
1152
|
+
|
1153
|
+
## datacenters_applicationloadbalancers_forwardingrules_put
|
1154
|
+
|
1155
|
+
> <ApplicationLoadBalancerForwardingRule> datacenters_applicationloadbalancers_forwardingrules_put(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
|
1156
|
+
|
1157
|
+
Modify ALB forwarding rules
|
1158
|
+
|
1159
|
+
Modify the specified Application Load Balancer forwarding rule.
|
1160
|
+
|
1161
|
+
### Examples
|
1162
|
+
|
1163
|
+
```ruby
|
1164
|
+
require 'time'
|
1165
|
+
require 'ionoscloud'
|
1166
|
+
# setup authorization
|
1167
|
+
Ionoscloud.configure do |config|
|
1168
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1169
|
+
config.username = 'YOUR USERNAME'
|
1170
|
+
config.password = 'YOUR PASSWORD'
|
1171
|
+
|
1172
|
+
# Configure API key authorization: Token Authentication
|
1173
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1174
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1175
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1176
|
+
end
|
1177
|
+
|
1178
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1179
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1180
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
1181
|
+
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
|
1182
|
+
application_load_balancer_forwarding_rule = Ionoscloud::ApplicationLoadBalancerForwardingRulePut.new({properties: Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP', listener_ip: '81.173.1.2', listener_port: 8080})}) # ApplicationLoadBalancerForwardingRulePut | The modified ALB forwarding rule.
|
1183
|
+
opts = {
|
1184
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1185
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1186
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1187
|
+
}
|
1188
|
+
|
1189
|
+
begin
|
1190
|
+
# Modify ALB forwarding rules
|
1191
|
+
result = api_instance.datacenters_applicationloadbalancers_forwardingrules_put(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
|
1192
|
+
p result
|
1193
|
+
rescue Ionoscloud::ApiError => e
|
1194
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_put: #{e}"
|
1195
|
+
end
|
1196
|
+
```
|
1197
|
+
|
1198
|
+
#### Using the datacenters_applicationloadbalancers_forwardingrules_put_with_http_info variant
|
1199
|
+
|
1200
|
+
This returns an Array which contains the response data, status code and headers.
|
1201
|
+
|
1202
|
+
> <Array(<ApplicationLoadBalancerForwardingRule>, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_put_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
|
1203
|
+
|
1204
|
+
```ruby
|
1205
|
+
begin
|
1206
|
+
# Modify ALB forwarding rules
|
1207
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_put_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
|
1208
|
+
p status_code # => 2xx
|
1209
|
+
p headers # => { ... }
|
1210
|
+
p data # => <ApplicationLoadBalancerForwardingRule>
|
1211
|
+
rescue Ionoscloud::ApiError => e
|
1212
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_put_with_http_info: #{e}"
|
1213
|
+
end
|
1214
|
+
```
|
1215
|
+
|
1216
|
+
### Parameters
|
1217
|
+
|
1218
|
+
| Name | Type | Description | Notes |
|
1219
|
+
| ---- | ---- | ----------- | ----- |
|
1220
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1221
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
1222
|
+
| **forwarding_rule_id** | **String** | The unique ID of the forwarding rule. | |
|
1223
|
+
| **application_load_balancer_forwarding_rule** | [**ApplicationLoadBalancerForwardingRulePut**](ApplicationLoadBalancerForwardingRulePut.md) | The modified ALB forwarding rule. | |
|
1224
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1225
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1226
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1227
|
+
|
1228
|
+
### Return type
|
1229
|
+
|
1230
|
+
[**ApplicationLoadBalancerForwardingRule**](../models/ApplicationLoadBalancerForwardingRule.md)
|
1231
|
+
|
1232
|
+
### Authorization
|
1233
|
+
|
1234
|
+
Basic Authentication, Token Authentication
|
1235
|
+
|
1236
|
+
### HTTP request headers
|
1237
|
+
|
1238
|
+
- **Content-Type**: application/json
|
1239
|
+
- **Accept**: application/json
|
1240
|
+
|
1241
|
+
|
1242
|
+
## datacenters_applicationloadbalancers_get
|
1243
|
+
|
1244
|
+
> <ApplicationLoadBalancers> datacenters_applicationloadbalancers_get(datacenter_id, opts)
|
1245
|
+
|
1246
|
+
List Application Load Balancers
|
1247
|
+
|
1248
|
+
List all Application Load Balancers within the data center.
|
1249
|
+
|
1250
|
+
### Examples
|
1251
|
+
|
1252
|
+
```ruby
|
1253
|
+
require 'time'
|
1254
|
+
require 'ionoscloud'
|
1255
|
+
# setup authorization
|
1256
|
+
Ionoscloud.configure do |config|
|
1257
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1258
|
+
config.username = 'YOUR USERNAME'
|
1259
|
+
config.password = 'YOUR PASSWORD'
|
1260
|
+
|
1261
|
+
# Configure API key authorization: Token Authentication
|
1262
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1263
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1264
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1268
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1269
|
+
opts = {
|
1270
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1271
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1272
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1273
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
|
1274
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
1275
|
+
}
|
1276
|
+
|
1277
|
+
begin
|
1278
|
+
# List Application Load Balancers
|
1279
|
+
result = api_instance.datacenters_applicationloadbalancers_get(datacenter_id, opts)
|
1280
|
+
p result
|
1281
|
+
rescue Ionoscloud::ApiError => e
|
1282
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_get: #{e}"
|
1283
|
+
end
|
1284
|
+
```
|
1285
|
+
|
1286
|
+
#### Using the datacenters_applicationloadbalancers_get_with_http_info variant
|
1287
|
+
|
1288
|
+
This returns an Array which contains the response data, status code and headers.
|
1289
|
+
|
1290
|
+
> <Array(<ApplicationLoadBalancers>, Integer, Hash)> datacenters_applicationloadbalancers_get_with_http_info(datacenter_id, opts)
|
1291
|
+
|
1292
|
+
```ruby
|
1293
|
+
begin
|
1294
|
+
# List Application Load Balancers
|
1295
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_get_with_http_info(datacenter_id, opts)
|
1296
|
+
p status_code # => 2xx
|
1297
|
+
p headers # => { ... }
|
1298
|
+
p data # => <ApplicationLoadBalancers>
|
1299
|
+
rescue Ionoscloud::ApiError => e
|
1300
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_get_with_http_info: #{e}"
|
1301
|
+
end
|
1302
|
+
```
|
1303
|
+
|
1304
|
+
### Parameters
|
1305
|
+
|
1306
|
+
| Name | Type | Description | Notes |
|
1307
|
+
| ---- | ---- | ----------- | ----- |
|
1308
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1309
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1310
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1311
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1312
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional][default to 0] |
|
1313
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
1314
|
+
|
1315
|
+
### Return type
|
1316
|
+
|
1317
|
+
[**ApplicationLoadBalancers**](../models/ApplicationLoadBalancers.md)
|
1318
|
+
|
1319
|
+
### Authorization
|
1320
|
+
|
1321
|
+
Basic Authentication, Token Authentication
|
1322
|
+
|
1323
|
+
### HTTP request headers
|
1324
|
+
|
1325
|
+
- **Content-Type**: Not defined
|
1326
|
+
- **Accept**: application/json
|
1327
|
+
|
1328
|
+
|
1329
|
+
## datacenters_applicationloadbalancers_patch
|
1330
|
+
|
1331
|
+
> <ApplicationLoadBalancer> datacenters_applicationloadbalancers_patch(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
|
1332
|
+
|
1333
|
+
Partially modify Application Load Balancers
|
1334
|
+
|
1335
|
+
Update the properties of the specified Application Load Balancer within the data center.
|
1336
|
+
|
1337
|
+
### Examples
|
1338
|
+
|
1339
|
+
```ruby
|
1340
|
+
require 'time'
|
1341
|
+
require 'ionoscloud'
|
1342
|
+
# setup authorization
|
1343
|
+
Ionoscloud.configure do |config|
|
1344
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1345
|
+
config.username = 'YOUR USERNAME'
|
1346
|
+
config.password = 'YOUR PASSWORD'
|
1347
|
+
|
1348
|
+
# Configure API key authorization: Token Authentication
|
1349
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1350
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1351
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1355
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1356
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
1357
|
+
application_load_balancer_properties = Ionoscloud::ApplicationLoadBalancerProperties.new({name: 'My Application Load Balancer', listener_lan: 1, target_lan: 2}) # ApplicationLoadBalancerProperties | The Application Load Balancer properties to be updated.
|
1358
|
+
opts = {
|
1359
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1360
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1361
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1362
|
+
}
|
1363
|
+
|
1364
|
+
begin
|
1365
|
+
# Partially modify Application Load Balancers
|
1366
|
+
result = api_instance.datacenters_applicationloadbalancers_patch(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
|
1367
|
+
p result
|
1368
|
+
rescue Ionoscloud::ApiError => e
|
1369
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_patch: #{e}"
|
1370
|
+
end
|
1371
|
+
```
|
1372
|
+
|
1373
|
+
#### Using the datacenters_applicationloadbalancers_patch_with_http_info variant
|
1374
|
+
|
1375
|
+
This returns an Array which contains the response data, status code and headers.
|
1376
|
+
|
1377
|
+
> <Array(<ApplicationLoadBalancer>, Integer, Hash)> datacenters_applicationloadbalancers_patch_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
|
1378
|
+
|
1379
|
+
```ruby
|
1380
|
+
begin
|
1381
|
+
# Partially modify Application Load Balancers
|
1382
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_patch_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
|
1383
|
+
p status_code # => 2xx
|
1384
|
+
p headers # => { ... }
|
1385
|
+
p data # => <ApplicationLoadBalancer>
|
1386
|
+
rescue Ionoscloud::ApiError => e
|
1387
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_patch_with_http_info: #{e}"
|
1388
|
+
end
|
1389
|
+
```
|
1390
|
+
|
1391
|
+
### Parameters
|
1392
|
+
|
1393
|
+
| Name | Type | Description | Notes |
|
1394
|
+
| ---- | ---- | ----------- | ----- |
|
1395
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1396
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
1397
|
+
| **application_load_balancer_properties** | [**ApplicationLoadBalancerProperties**](ApplicationLoadBalancerProperties.md) | The Application Load Balancer properties to be updated. | |
|
1398
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1399
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1400
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1401
|
+
|
1402
|
+
### Return type
|
1403
|
+
|
1404
|
+
[**ApplicationLoadBalancer**](../models/ApplicationLoadBalancer.md)
|
1405
|
+
|
1406
|
+
### Authorization
|
1407
|
+
|
1408
|
+
Basic Authentication, Token Authentication
|
1409
|
+
|
1410
|
+
### HTTP request headers
|
1411
|
+
|
1412
|
+
- **Content-Type**: Not defined
|
1413
|
+
- **Accept**: application/json
|
1414
|
+
|
1415
|
+
|
1416
|
+
## datacenters_applicationloadbalancers_post
|
1417
|
+
|
1418
|
+
> <ApplicationLoadBalancer> datacenters_applicationloadbalancers_post(datacenter_id, application_load_balancer, opts)
|
1419
|
+
|
1420
|
+
Create Application Load Balancers
|
1421
|
+
|
1422
|
+
Create an Application Load Balancer within the datacenter.
|
1423
|
+
|
1424
|
+
### Examples
|
1425
|
+
|
1426
|
+
```ruby
|
1427
|
+
require 'time'
|
1428
|
+
require 'ionoscloud'
|
1429
|
+
# setup authorization
|
1430
|
+
Ionoscloud.configure do |config|
|
1431
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1432
|
+
config.username = 'YOUR USERNAME'
|
1433
|
+
config.password = 'YOUR PASSWORD'
|
1434
|
+
|
1435
|
+
# Configure API key authorization: Token Authentication
|
1436
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1437
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1438
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1439
|
+
end
|
1440
|
+
|
1441
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1442
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1443
|
+
application_load_balancer = Ionoscloud::ApplicationLoadBalancer.new({properties: Ionoscloud::ApplicationLoadBalancerProperties.new({name: 'My Application Load Balancer', listener_lan: 1, target_lan: 2})}) # ApplicationLoadBalancer | The Application Load Balancer to create.
|
1444
|
+
opts = {
|
1445
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1446
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1447
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1448
|
+
}
|
1449
|
+
|
1450
|
+
begin
|
1451
|
+
# Create Application Load Balancers
|
1452
|
+
result = api_instance.datacenters_applicationloadbalancers_post(datacenter_id, application_load_balancer, opts)
|
1453
|
+
p result
|
1454
|
+
rescue Ionoscloud::ApiError => e
|
1455
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_post: #{e}"
|
1456
|
+
end
|
1457
|
+
```
|
1458
|
+
|
1459
|
+
#### Using the datacenters_applicationloadbalancers_post_with_http_info variant
|
1460
|
+
|
1461
|
+
This returns an Array which contains the response data, status code and headers.
|
1462
|
+
|
1463
|
+
> <Array(<ApplicationLoadBalancer>, Integer, Hash)> datacenters_applicationloadbalancers_post_with_http_info(datacenter_id, application_load_balancer, opts)
|
1464
|
+
|
1465
|
+
```ruby
|
1466
|
+
begin
|
1467
|
+
# Create Application Load Balancers
|
1468
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_post_with_http_info(datacenter_id, application_load_balancer, opts)
|
1469
|
+
p status_code # => 2xx
|
1470
|
+
p headers # => { ... }
|
1471
|
+
p data # => <ApplicationLoadBalancer>
|
1472
|
+
rescue Ionoscloud::ApiError => e
|
1473
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_post_with_http_info: #{e}"
|
1474
|
+
end
|
1475
|
+
```
|
1476
|
+
|
1477
|
+
### Parameters
|
1478
|
+
|
1479
|
+
| Name | Type | Description | Notes |
|
1480
|
+
| ---- | ---- | ----------- | ----- |
|
1481
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1482
|
+
| **application_load_balancer** | [**ApplicationLoadBalancer**](ApplicationLoadBalancer.md) | The Application Load Balancer to create. | |
|
1483
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1484
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1485
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1486
|
+
|
1487
|
+
### Return type
|
1488
|
+
|
1489
|
+
[**ApplicationLoadBalancer**](../models/ApplicationLoadBalancer.md)
|
1490
|
+
|
1491
|
+
### Authorization
|
1492
|
+
|
1493
|
+
Basic Authentication, Token Authentication
|
1494
|
+
|
1495
|
+
### HTTP request headers
|
1496
|
+
|
1497
|
+
- **Content-Type**: application/json
|
1498
|
+
- **Accept**: application/json
|
1499
|
+
|
1500
|
+
|
1501
|
+
## datacenters_applicationloadbalancers_put
|
1502
|
+
|
1503
|
+
> <ApplicationLoadBalancer> datacenters_applicationloadbalancers_put(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
|
1504
|
+
|
1505
|
+
Modify Application Load Balancers
|
1506
|
+
|
1507
|
+
Modify the properties of the specified Application Load Balancer within the data center.
|
1508
|
+
|
1509
|
+
### Examples
|
1510
|
+
|
1511
|
+
```ruby
|
1512
|
+
require 'time'
|
1513
|
+
require 'ionoscloud'
|
1514
|
+
# setup authorization
|
1515
|
+
Ionoscloud.configure do |config|
|
1516
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1517
|
+
config.username = 'YOUR USERNAME'
|
1518
|
+
config.password = 'YOUR PASSWORD'
|
1519
|
+
|
1520
|
+
# Configure API key authorization: Token Authentication
|
1521
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1523
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1524
|
+
end
|
1525
|
+
|
1526
|
+
api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
|
1527
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
1528
|
+
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
|
1529
|
+
application_load_balancer = Ionoscloud::ApplicationLoadBalancerPut.new({properties: Ionoscloud::ApplicationLoadBalancerProperties.new({name: 'My Application Load Balancer', listener_lan: 1, target_lan: 2})}) # ApplicationLoadBalancerPut | The modified Application Load Balancer.
|
1530
|
+
opts = {
|
1531
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1532
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1533
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
1534
|
+
}
|
1535
|
+
|
1536
|
+
begin
|
1537
|
+
# Modify Application Load Balancers
|
1538
|
+
result = api_instance.datacenters_applicationloadbalancers_put(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
|
1539
|
+
p result
|
1540
|
+
rescue Ionoscloud::ApiError => e
|
1541
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_put: #{e}"
|
1542
|
+
end
|
1543
|
+
```
|
1544
|
+
|
1545
|
+
#### Using the datacenters_applicationloadbalancers_put_with_http_info variant
|
1546
|
+
|
1547
|
+
This returns an Array which contains the response data, status code and headers.
|
1548
|
+
|
1549
|
+
> <Array(<ApplicationLoadBalancer>, Integer, Hash)> datacenters_applicationloadbalancers_put_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
|
1550
|
+
|
1551
|
+
```ruby
|
1552
|
+
begin
|
1553
|
+
# Modify Application Load Balancers
|
1554
|
+
data, status_code, headers = api_instance.datacenters_applicationloadbalancers_put_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
|
1555
|
+
p status_code # => 2xx
|
1556
|
+
p headers # => { ... }
|
1557
|
+
p data # => <ApplicationLoadBalancer>
|
1558
|
+
rescue Ionoscloud::ApiError => e
|
1559
|
+
puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_put_with_http_info: #{e}"
|
1560
|
+
end
|
1561
|
+
```
|
1562
|
+
|
1563
|
+
### Parameters
|
1564
|
+
|
1565
|
+
| Name | Type | Description | Notes |
|
1566
|
+
| ---- | ---- | ----------- | ----- |
|
1567
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
1568
|
+
| **application_load_balancer_id** | **String** | The unique ID of the Application Load Balancer. | |
|
1569
|
+
| **application_load_balancer** | [**ApplicationLoadBalancerPut**](ApplicationLoadBalancerPut.md) | The modified Application Load Balancer. | |
|
1570
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1571
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1572
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
1573
|
+
|
1574
|
+
### Return type
|
1575
|
+
|
1576
|
+
[**ApplicationLoadBalancer**](../models/ApplicationLoadBalancer.md)
|
1577
|
+
|
1578
|
+
### Authorization
|
1579
|
+
|
1580
|
+
Basic Authentication, Token Authentication
|
1581
|
+
|
1582
|
+
### HTTP request headers
|
1583
|
+
|
1584
|
+
- **Content-Type**: application/json
|
1585
|
+
- **Accept**: application/json
|
1586
|
+
|