NetworkLoadBalancersApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Delete Network Load Balancers | |
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Retrieve Network Load Balancers | |
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Delete NLB Flow Logs | |
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Retrieve NLB Flow Logs | |
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs | List NLB Flow Logs | |
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Partially modify NLB Flow Logs | |
POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs | Create a NLB Flow Log | |
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Modify NLB Flow Logs | |
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Delete NLB forwarding rules | |
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Retrieve NLB forwarding rules | |
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules | List NLB forwarding rules | |
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Partially modify NLB forwarding rules | |
POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules | Create a NLB Forwarding Rule | |
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Modify NLB forwarding rules | |
GET /datacenters/{datacenterId}/networkloadbalancers | List Network Load Balancers | |
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Partially modify Network Load Balancers | |
POST /datacenters/{datacenterId}/networkloadbalancers | Create a Network Load Balancer | |
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Modify Network Load Balancers |
datacenters_networkloadbalancers_delete(datacenter_id, network_load_balancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Network Load Balancers
Remove the specified Network 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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
try:
# Delete Network Load Balancers
api_instance.datacenters_networkloadbalancers_delete(datacenter_id, network_load_balancer_id)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network 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
NetworkLoadBalancer datacenters_networkloadbalancers_find_by_network_load_balancer_id(datacenter_id, network_load_balancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Network Load Balancers
Retrieve the properties of the specified Network 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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
try:
# Retrieve Network Load Balancers
api_response = api_instance.datacenters_networkloadbalancers_find_by_network_load_balancer_id(datacenter_id, network_load_balancer_id)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_find_by_network_load_balancer_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network 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
datacenters_networkloadbalancers_flowlogs_delete(datacenter_id, network_load_balancer_id, flow_log_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete NLB Flow Logs
Delete the specified Network Load Balancer Flow Log.
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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
try:
# Delete NLB Flow Logs
api_instance.datacenters_networkloadbalancers_flowlogs_delete(datacenter_id, network_load_balancer_id, flow_log_id)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network Load Balancer. | |
flow_log_id | str | The unique ID of the Flow Log. | |
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
FlowLog datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, network_load_balancer_id, flow_log_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve NLB Flow Logs
Retrieve the specified Network Load Balancer Flow Log.
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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
try:
# Retrieve NLB Flow Logs
api_response = api_instance.datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, network_load_balancer_id, flow_log_id)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network Load Balancer. | |
flow_log_id | str | The unique ID of the Flow Log. | |
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
FlowLogs datacenters_networkloadbalancers_flowlogs_get(datacenter_id, network_load_balancer_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List NLB Flow Logs
List all the Flow Logs for the specified Network 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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
try:
# List NLB Flow Logs
api_response = api_instance.datacenters_networkloadbalancers_flowlogs_get(datacenter_id, network_load_balancer_id)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_get: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network 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
FlowLog datacenters_networkloadbalancers_flowlogs_patch(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Partially modify NLB Flow Logs
Update the properties of the specified Network Load Balancer Flow Log.
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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
network_load_balancer_flow_log_properties = ionoscloud.FlowLogProperties() # FlowLogProperties | The properties of the Flow Log to be updated.
try:
# Partially modify NLB Flow Logs
api_response = api_instance.datacenters_networkloadbalancers_flowlogs_patch(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_patch: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network Load Balancer. | |
flow_log_id | str | The unique ID of the Flow Log. | |
network_load_balancer_flow_log_properties | The properties of the Flow Log 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: Not defined
- Accept: application/json
FlowLog datacenters_networkloadbalancers_flowlogs_post(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Create a NLB Flow Log
Adds a new Flow Log for the Network 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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
network_load_balancer_flow_log = ionoscloud.FlowLog() # FlowLog | The Flow Log to create.
try:
# Create a NLB Flow Log
api_response = api_instance.datacenters_networkloadbalancers_flowlogs_post(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_post: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network Load Balancer. | |
network_load_balancer_flow_log | The Flow Log 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] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
FlowLog datacenters_networkloadbalancers_flowlogs_put(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify NLB Flow Logs
Modify the specified Network Load Balancer Flow Log.
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.NetworkLoadBalancersApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
network_load_balancer_id = 'network_load_balancer_id_example' # str | The unique ID of the Network Load Balancer.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
network_load_balancer_flow_log = ionoscloud.FlowLogPut() # FlowLogPut | The modified NLB Flow Log.
try:
# Modify NLB Flow Logs
api_response = api_instance.datacenters_networkloadbalancers_flowlogs_put(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log)
print(api_response)
except ApiException as e:
print('Exception when calling NetworkLoadBalancersApi.datacenters_networkloadbalancers_flowlogs_put: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
network_load_balancer_id | str | The unique ID of the Network Load Balancer. | |
flow_log_id | str | The unique ID of the Flow Log. | |
network_load_balancer_flow_log | The modified NLB Flow Log. | | |
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