ApplicationLoadBalancersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

MethodHTTP requestDescription

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Delete an Application Load Balancer by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Get an Application Load Balancer by ID

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Delete an ALB Flow Log by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Get an ALB Flow Log by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs

Get ALB Flow Logs

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Partially Modify an ALB Flow Log by ID

POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs

Create an ALB Flow Log

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Modify an ALB Flow Log by ID

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Delete an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Get an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules

Get ALB Forwarding Rules

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Partially modify an ALB Forwarding Rule by ID

POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules

Create an ALB Forwarding Rule

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Modify an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers

Get Application Load Balancers

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Partially Modify an Application Load Balancer by ID

POST /datacenters/{datacenterId}/applicationloadbalancers

Create an Application Load Balancer

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Modify an Application Load Balancer by ID

datacenters_applicationloadbalancers_delete

datacenters_applicationloadbalancers_delete(datacenter_id, application_load_balancer_id, opts)

Delete an Application Load Balancer by ID

Removes the specified Application Load Balancer from the data center.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Delete an Application Load Balancer by ID
  api_instance.datacenters_applicationloadbalancers_delete(datacenter_id, application_load_balancer_id, opts)
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_delete: #{e}"
end

Using the datacenters_applicationloadbalancers_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_delete_with_http_info(datacenter_id, application_load_balancer_id, opts)

begin
  # Delete an Application Load Balancer by ID
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_delete_with_http_info(datacenter_id, application_load_balancer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_delete_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_find_by_application_load_balancer_id

datacenters_applicationloadbalancers_find_by_application_load_balancer_id(datacenter_id, application_load_balancer_id, opts)

Get an Application Load Balancer by ID

Retrieves the properties of the specified Application Load Balancer within the data center.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Get an Application Load Balancer by ID
  result = api_instance.datacenters_applicationloadbalancers_find_by_application_load_balancer_id(datacenter_id, application_load_balancer_id, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_find_by_application_load_balancer_id: #{e}"
end

Using the datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info(datacenter_id, application_load_balancer_id, opts)

begin
  # Get an Application Load Balancer by ID
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info(datacenter_id, application_load_balancer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancer>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancer

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_delete

datacenters_applicationloadbalancers_flowlogs_delete(datacenter_id, application_load_balancer_id, flow_log_id, opts)

Delete an ALB Flow Log by ID

Deletes the Application Load Balancer flow log specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Delete an ALB Flow Log by ID
  api_instance.datacenters_applicationloadbalancers_flowlogs_delete(datacenter_id, application_load_balancer_id, flow_log_id, opts)
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_delete: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_delete_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)

begin
  # Delete an ALB Flow Log by ID
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_delete_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_delete_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

flow_log_id

String

The unique ID of the flow log.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id

datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, application_load_balancer_id, flow_log_id, opts)

Get an ALB Flow Log by ID

Retrieves the Application Load Balancer flow log specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Get an ALB Flow Log by ID
  result = api_instance.datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, application_load_balancer_id, flow_log_id, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)

begin
  # Get an ALB Flow Log by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

flow_log_id

String

The unique ID of the flow log.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

FlowLog

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_get

datacenters_applicationloadbalancers_flowlogs_get(datacenter_id, application_load_balancer_id, opts)

Get ALB Flow Logs

Retrieves the flow logs for the specified Application Load Balancer.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Get ALB Flow Logs
  result = api_instance.datacenters_applicationloadbalancers_flowlogs_get(datacenter_id, application_load_balancer_id, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_get: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_get_with_http_info(datacenter_id, application_load_balancer_id, opts)

begin
  # Get ALB Flow Logs
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_flowlogs_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlowLogs>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_get_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

FlowLogs

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_patch

datacenters_applicationloadbalancers_flowlogs_patch(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)

Partially Modify an ALB Flow Log by ID

Updates the properties of the Application Load Balancer flow log specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log.
application_load_balancer_flow_log_properties = Ionoscloud::FlowLogProperties.new({action: 'ACCEPTED', bucket: 'bucketName/key', direction: 'INGRESS', name: 'My resource'}) # FlowLogProperties | The properties of the ALB flow log to be updated.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Partially Modify an ALB Flow Log by ID
  result = api_instance.datacenters_applicationloadbalancers_flowlogs_patch(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_patch: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_patch_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, 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)

begin
  # Partially Modify an ALB Flow Log by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_patch_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

flow_log_id

String

The unique ID of the flow log.

application_load_balancer_flow_log_properties

The properties of the ALB flow log to be updated.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

FlowLog

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_post

datacenters_applicationloadbalancers_flowlogs_post(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)

Create an ALB Flow Log

Creates a flow log for the Application Load Balancer specified by ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
application_load_balancer_flow_log = Ionoscloud::FlowLog.new({properties: Ionoscloud::FlowLogProperties.new({action: 'ACCEPTED', bucket: 'bucketName/key', direction: 'INGRESS', name: 'My resource'})}) # FlowLog | The flow log to create.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Create an ALB Flow Log
  result = api_instance.datacenters_applicationloadbalancers_flowlogs_post(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_post: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)

begin
  # Create an ALB Flow Log
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_post_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

application_load_balancer_flow_log

The flow log to create.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

FlowLog

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_applicationloadbalancers_flowlogs_put

datacenters_applicationloadbalancers_flowlogs_put(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)

Modify an ALB Flow Log by ID

Modifies the Application Load Balancer flow log specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log.
application_load_balancer_flow_log = Ionoscloud::FlowLogPut.new({properties: Ionoscloud::FlowLogProperties.new({action: 'ACCEPTED', bucket: 'bucketName/key', direction: 'INGRESS', name: 'My resource'})}) # FlowLogPut | The modified ALB flow log.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Modify an ALB Flow Log by ID
  result = api_instance.datacenters_applicationloadbalancers_flowlogs_put(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_put: #{e}"
end

Using the datacenters_applicationloadbalancers_flowlogs_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_put_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)

begin
  # Modify an ALB Flow Log by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_flowlogs_put_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

flow_log_id

String

The unique ID of the flow log.

application_load_balancer_flow_log

The modified ALB flow log.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

FlowLog

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_delete

datacenters_applicationloadbalancers_forwardingrules_delete(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)

Delete an ALB Forwarding Rule by ID

Deletes the Application Load Balancer forwarding rule specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Delete an ALB Forwarding Rule by ID
  api_instance.datacenters_applicationloadbalancers_forwardingrules_delete(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_delete: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)

begin
  # Delete an ALB Forwarding Rule by ID
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

forwarding_rule_id

String

The unique ID of the forwarding rule.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id

datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)

Get an ALB Forwarding Rule by ID

Retrieves the Application Load Balancer forwarding rule specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Get an ALB Forwarding Rule by ID
  result = api_instance.datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)

begin
  # Get an ALB Forwarding Rule by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancerForwardingRule>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

forwarding_rule_id

String

The unique ID of the forwarding rule.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancerForwardingRule

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_get

datacenters_applicationloadbalancers_forwardingrules_get(datacenter_id, application_load_balancer_id, opts)

Get ALB Forwarding Rules

Lists the forwarding rules of the specified Application Load Balancer.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Get ALB Forwarding Rules
  result = api_instance.datacenters_applicationloadbalancers_forwardingrules_get(datacenter_id, application_load_balancer_id, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_get: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_get_with_http_info(datacenter_id, application_load_balancer_id, opts)

begin
  # Get ALB Forwarding Rules
  data, status_code, headers = api_instance.datacenters_applicationloadbalancers_forwardingrules_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancerForwardingRules>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_get_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancerForwardingRules

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_patch

datacenters_applicationloadbalancers_forwardingrules_patch(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)

Partially modify an ALB Forwarding Rule by ID

Updates the properties of the Application Load Balancer forwarding rule specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
application_load_balancer_forwarding_rule_properties = Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({listener_ip: '81.173.1.2', listener_port: 8080, name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP'}) # ApplicationLoadBalancerForwardingRuleProperties | The properties of the forwarding rule to be updated.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Partially modify an ALB Forwarding Rule by ID
  result = api_instance.datacenters_applicationloadbalancers_forwardingrules_patch(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_patch: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, 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)

begin
  # Partially modify an ALB Forwarding Rule by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancerForwardingRule>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

forwarding_rule_id

String

The unique ID of the forwarding rule.

application_load_balancer_forwarding_rule_properties

The properties of the forwarding rule to be updated.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancerForwardingRule

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_post

datacenters_applicationloadbalancers_forwardingrules_post(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)

Create an ALB Forwarding Rule

Creates a forwarding rule for the specified Application Load Balancer.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
application_load_balancer_forwarding_rule = Ionoscloud::ApplicationLoadBalancerForwardingRule.new({properties: Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({listener_ip: '81.173.1.2', listener_port: 8080, name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP'})}) # ApplicationLoadBalancerForwardingRule | The forwarding rule to create.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Create an ALB Forwarding Rule
  result = api_instance.datacenters_applicationloadbalancers_forwardingrules_post(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_post: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)

begin
  # Create an ALB Forwarding Rule
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancerForwardingRule>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_post_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

application_load_balancer_forwarding_rule

The forwarding rule to create.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancerForwardingRule

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_applicationloadbalancers_forwardingrules_put

datacenters_applicationloadbalancers_forwardingrules_put(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)

Modify an ALB Forwarding Rule by ID

Modifies the Application Load Balancer forwarding rule specified by its ID.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
  # Configure HTTP basic authorization: Basic Authentication
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token Authentication
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = Ionoscloud::ApplicationLoadBalancersApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
application_load_balancer_id = 'application_load_balancer_id_example' # String | The unique ID of the Application Load Balancer.
forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule.
application_load_balancer_forwarding_rule = Ionoscloud::ApplicationLoadBalancerForwardingRulePut.new({properties: Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new({listener_ip: '81.173.1.2', listener_port: 8080, name: 'My Application Load Balancer forwarding rule', protocol: 'HTTP'})}) # ApplicationLoadBalancerForwardingRulePut | The modified ALB forwarding rule.
opts = {
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
  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
  x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}

begin
  # Modify an ALB Forwarding Rule by ID
  result = api_instance.datacenters_applicationloadbalancers_forwardingrules_put(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
  p result
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_put: #{e}"
end

Using the datacenters_applicationloadbalancers_forwardingrules_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_put_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)

begin
  # Modify an ALB Forwarding Rule by ID
  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)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationLoadBalancerForwardingRule>
rescue Ionoscloud::ApiError => e
  puts "Error when calling ApplicationLoadBalancersApi->datacenters_applicationloadbalancers_forwardingrules_put_with_http_info: #{e}"
end

Parameters

NameTypeDescriptionNotes

datacenter_id

String

The unique ID of the data center.

application_load_balancer_id

String

The unique ID of the Application Load Balancer.

forwarding_rule_id

String

The unique ID of the forwarding rule.

application_load_balancer_forwarding_rule

The modified ALB forwarding rule.

pretty

Boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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]

x_contract_number

Integer

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

ApplicationLoadBalancerForwardingRule

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_applicationloadbalancers_get

datacenters_applicationloadbalancers_get(datacenter_id, opts)

Get Application Load Balancers

Lists all Application Load Balancers within a data center.

Examples

require 'time'
require