1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
|
# LoadBalancersApi
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**datacenters_loadbalancers_balancednics_delete**](LoadBalancersApi.md#datacenters_loadbalancers_balancednics_delete) | **DELETE** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Detach balanced NICs |
| [**datacenters_loadbalancers_balancednics_find_by_nic_id**](LoadBalancersApi.md#datacenters_loadbalancers_balancednics_find_by_nic_id) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Retrieve balanced NICs |
| [**datacenters_loadbalancers_balancednics_get**](LoadBalancersApi.md#datacenters_loadbalancers_balancednics_get) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | List balanced NICs |
| [**datacenters_loadbalancers_balancednics_post**](LoadBalancersApi.md#datacenters_loadbalancers_balancednics_post) | **POST** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | Attach balanced NICs |
| [**datacenters_loadbalancers_delete**](LoadBalancersApi.md#datacenters_loadbalancers_delete) | **DELETE** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Delete Load Balancers |
| [**datacenters_loadbalancers_find_by_id**](LoadBalancersApi.md#datacenters_loadbalancers_find_by_id) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Retrieve Load Balancers |
| [**datacenters_loadbalancers_get**](LoadBalancersApi.md#datacenters_loadbalancers_get) | **GET** /datacenters/{datacenterId}/loadbalancers | List Load Balancers |
| [**datacenters_loadbalancers_patch**](LoadBalancersApi.md#datacenters_loadbalancers_patch) | **PATCH** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Partially modify Load Balancers |
| [**datacenters_loadbalancers_post**](LoadBalancersApi.md#datacenters_loadbalancers_post) | **POST** /datacenters/{datacenterId}/loadbalancers | Create a Load Balancer |
| [**datacenters_loadbalancers_put**](LoadBalancersApi.md#datacenters_loadbalancers_put) | **PUT** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Modify a Load Balancer by ID |
# **datacenters_loadbalancers_balancednics_delete**
> datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Detach balanced NICs
Detach the specified NIC from the Load Balancer.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
nic_id = 'nic_id_example' # str | The unique ID of the NIC.
try:
# Detach balanced NICs
api_instance.datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **nic_id** | **str**| The unique ID of the NIC. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
void (empty response body)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_balancednics_find_by_nic_id**
> Nic datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve balanced NICs
Retrieve the properties of the specified NIC, attached to the Load Balancer.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
nic_id = 'nic_id_example' # str | The unique ID of the NIC.
try:
# Retrieve balanced NICs
api_response = api_instance.datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **nic_id** | **str**| The unique ID of the NIC. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Nic**](../models/Nic.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_balancednics_get**
> BalancedNics datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List balanced NICs
List all NICs, attached to the specified Load Balancer.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
try:
# List balanced NICs
api_response = api_instance.datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_get: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**BalancedNics**](../models/BalancedNics.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_balancednics_post**
> Nic datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Attach balanced NICs
Attachs an existing NIC to the specified Load Balancer.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
nic = ionoscloud.Nic() # Nic | The NIC to be attached.
try:
# Attach balanced NICs
api_response = api_instance.datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **nic** | [**Nic**](../models/Nic.md)| The NIC to be attached. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Nic**](../models/Nic.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **datacenters_loadbalancers_delete**
> datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Load Balancers
Remove the specified Load Balancer from the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
try:
# Delete Load Balancers
api_instance.datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_delete: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
void (empty response body)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_find_by_id**
> Loadbalancer datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Load Balancers
Retrieve the properties of the specified Load Balancer within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
try:
# Retrieve Load Balancers
api_response = api_instance.datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_find_by_id: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Loadbalancer**](../models/Loadbalancer.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_get**
> Loadbalancers datacenters_loadbalancers_get(datacenter_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number, offset=offset, limit=limit)
List Load Balancers
List all the Load Balancers within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
try:
# List Load Balancers
api_response = api_instance.datacenters_loadbalancers_get(datacenter_id)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_get: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
| **offset** | **int**| 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] |
| **limit** | **int**| The maximum number of elements to return (use together with offset for pagination). | [optional] [default to 1000] |
### Return type
[**Loadbalancers**](../models/Loadbalancers.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **datacenters_loadbalancers_patch**
> Loadbalancer datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Partially modify Load Balancers
Update the properties of the specified Load Balancer within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
loadbalancer = ionoscloud.LoadbalancerProperties() # LoadbalancerProperties | The properties of the Load Balancer to be updated.
try:
# Partially modify Load Balancers
api_response = api_instance.datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_patch: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **loadbalancer** | [**LoadbalancerProperties**](../models/LoadbalancerProperties.md)| The properties of the Load Balancer to be updated. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Loadbalancer**](../models/Loadbalancer.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **datacenters_loadbalancers_post**
> Loadbalancer datacenters_loadbalancers_post(datacenter_id, loadbalancer, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Create a Load Balancer
Creates a Load Balancer within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer = ionoscloud.Loadbalancer() # Loadbalancer | The Load Balancer to create.
try:
# Create a Load Balancer
api_response = api_instance.datacenters_loadbalancers_post(datacenter_id, loadbalancer)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_post: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer** | [**Loadbalancer**](../models/Loadbalancer.md)| The Load Balancer to create. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Loadbalancer**](../models/Loadbalancer.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **datacenters_loadbalancers_put**
> Loadbalancer datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify a Load Balancer by ID
Modifies the properties of the specified Load Balancer within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.LoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
loadbalancer_id = 'loadbalancer_id_example' # str | The unique ID of the Load Balancer.
loadbalancer = ionoscloud.Loadbalancer() # Loadbalancer | The modified Load Balancer.
try:
# Modify a Load Balancer by ID
api_response = api_instance.datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer)
print(api_response)
except ApiException as e:
print('Exception when calling LoadBalancersApi.datacenters_loadbalancers_put: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **datacenter_id** | **str**| The unique ID of the data center. | |
| **loadbalancer_id** | **str**| The unique ID of the Load Balancer. | |
| **loadbalancer** | [**Loadbalancer**](../models/Loadbalancer.md)| The modified Load Balancer. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| 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] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Loadbalancer**](../models/Loadbalancer.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
|