LoadBalancersApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Detach balanced NICs | |
GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Retrieve balanced NICs | |
GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | List balanced NICs | |
POST /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | Attach balanced NICs | |
DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Delete Load Balancers | |
GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Retrieve Load Balancers | |
GET /datacenters/{datacenterId}/loadbalancers | List Load Balancers | |
PATCH /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Partially modify Load Balancers | |
POST /datacenters/{datacenterId}/loadbalancers | Create a Load Balancer | |
PUT /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Modify a Load Balancer by ID |
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.
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)
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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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 | 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] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
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.
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)
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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
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.
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)
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 | 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] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
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.
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)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
loadbalancer | The Load Balancer to create. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). |