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
datacenters_networkloadbalancers_delete(datacenter_id, network_load_balancer_id, opts)
Delete Network Load Balancers
Remove the specified Network Load Balancer from the data center.
Examples
Using the datacenters_networkloadbalancers_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_networkloadbalancers_delete_with_http_info(datacenter_id, network_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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_networkloadbalancers_find_by_network_load_balancer_id
datacenters_networkloadbalancers_find_by_network_load_balancer_id(datacenter_id, network_load_balancer_id, opts)
Retrieve Network Load Balancers
Retrieve the properties of the specified Network Load Balancer within the data center.
Examples
Using the datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info(datacenter_id, network_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_flowlogs_delete
datacenters_networkloadbalancers_flowlogs_delete(datacenter_id, network_load_balancer_id, flow_log_id, opts)
Delete NLB Flow Logs
Delete the specified Network Load Balancer Flow Log.
Examples
Using the datacenters_networkloadbalancers_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_networkloadbalancers_flowlogs_delete_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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_networkloadbalancers_flowlogs_find_by_flow_log_id
datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, network_load_balancer_id, flow_log_id, opts)
Retrieve NLB Flow Logs
Retrieve the specified Network Load Balancer Flow Log.
Examples
Using the datacenters_networkloadbalancers_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_networkloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_flowlogs_get
datacenters_networkloadbalancers_flowlogs_get(datacenter_id, network_load_balancer_id, opts)
List NLB Flow Logs
List all the Flow Logs for the specified Network Load Balancer.
Examples
Using the datacenters_networkloadbalancers_flowlogs_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_flowlogs_patch
datacenters_networkloadbalancers_flowlogs_patch(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
Partially modify NLB Flow Logs
Update the properties of the specified Network Load Balancer Flow Log.
Examples
Using the datacenters_networkloadbalancers_flowlogs_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_patch_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
flow_log_id | String | The unique ID of the Flow Log. | |
network_load_balancer_flow_log_properties | The properties of the 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_flowlogs_post
datacenters_networkloadbalancers_flowlogs_post(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
Create a NLB Flow Log
Adds a new Flow Log for the Network Load Balancer.
Examples
Using the datacenters_networkloadbalancers_flowlogs_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
network_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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_networkloadbalancers_flowlogs_put
datacenters_networkloadbalancers_flowlogs_put(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
Modify NLB Flow Logs
Modify the specified Network Load Balancer Flow Log.
Examples
Using the datacenters_networkloadbalancers_flowlogs_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_put_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
flow_log_id | String | The unique ID of the Flow Log. | |
network_load_balancer_flow_log | The modified NLB 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_networkloadbalancers_forwardingrules_delete
datacenters_networkloadbalancers_forwardingrules_delete(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
Delete NLB forwarding rules
Delete the specified Network Load Balancer forwarding rule.
Examples
Using the datacenters_networkloadbalancers_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_networkloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id
datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
Retrieve NLB forwarding rules
Retrieve the specified Network Load Balance forwarding rule.
Examples
Using the datacenters_networkloadbalancers_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_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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
NetworkLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_forwardingrules_get
datacenters_networkloadbalancers_forwardingrules_get(datacenter_id, network_load_balancer_id, opts)
List NLB forwarding rules
List the forwarding rules for the specified Network Load Balancer.
Examples
Using the datacenters_networkloadbalancers_forwardingrules_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network 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
NetworkLoadBalancerForwardingRules
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_forwardingrules_patch
datacenters_networkloadbalancers_forwardingrules_patch(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
Partially modify NLB forwarding rules
Update the properties of the specified Network Load Balancer forwarding rule.
Examples
Using the datacenters_networkloadbalancers_forwardingrules_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
forwarding_rule_id | String | The unique ID of the forwarding rule. | |
network_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
NetworkLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_forwardingrules_post
datacenters_networkloadbalancers_forwardingrules_post(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
Create a NLB Forwarding Rule
Creates a forwarding rule for the specified Network Load Balancer.
Examples
Using the datacenters_networkloadbalancers_forwardingrules_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
network_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
NetworkLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_networkloadbalancers_forwardingrules_put
datacenters_networkloadbalancers_forwardingrules_put(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
Modify NLB forwarding rules
Modify the specified Network Load Balancer forwarding rule.
Examples
Using the datacenters_networkloadbalancers_forwardingrules_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_put_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
forwarding_rule_id | String | The unique ID of the forwarding rule. | |
network_load_balancer_forwarding_rule | The modified NLB 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
NetworkLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_networkloadbalancers_get
datacenters_networkloadbalancers_get(datacenter_id, opts)
List Network Load Balancers
List all the Network Load Balancers within the data center.
Examples
Using the datacenters_networkloadbalancers_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_get_with_http_info(datacenter_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
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] |
offset | Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional][default to 0] |
limit | Integer | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_patch
datacenters_networkloadbalancers_patch(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
Partially modify Network Load Balancers
Update the properties of the specified Network Load Balancer within the data center.
Examples
Using the datacenters_networkloadbalancers_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_patch_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
network_load_balancer_properties | The properties of the Network Load Balancer 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_networkloadbalancers_post
datacenters_networkloadbalancers_post(datacenter_id, network_load_balancer, opts)
Create a Network Load Balancer
Creates a Network Load Balancer within the data center.
Examples
Using the datacenters_networkloadbalancers_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_post_with_http_info(datacenter_id, network_load_balancer, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer | The Network Load Balancer 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_networkloadbalancers_put
datacenters_networkloadbalancers_put(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
Modify Network Load Balancers
Modify the properties of the specified Network Load Balancer within the data center.
Examples
Using the datacenters_networkloadbalancers_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_networkloadbalancers_put_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
network_load_balancer_id | String | The unique ID of the Network Load Balancer. | |
network_load_balancer | The modified Network 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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated