Module hcloud::apis::load_balancers_api

Structs

• AddServiceParams
  struct for passing parameters to the method add_service
• AddTargetParams
  struct for passing parameters to the method add_target
• AttachLoadBalancerToNetworkParams
  struct for passing parameters to the method attach_load_balancer_to_network
• ChangeAlgorithmParams
  struct for passing parameters to the method change_algorithm
• ChangeLoadBalancerProtectionParams
  struct for passing parameters to the method change_load_balancer_protection
• ChangeReverseDnsEntryForThisLoadBalancerParams
  struct for passing parameters to the method change_reverse_dns_entry_for_this_load_balancer
• ChangeTypeOfLoadBalancerParams
  struct for passing parameters to the method change_type_of_load_balancer
• CreateLoadBalancerParams
  struct for passing parameters to the method create_load_balancer
• DeleteLoadBalancerParams
  struct for passing parameters to the method delete_load_balancer
• DeleteServiceParams
  struct for passing parameters to the method delete_service
• DetachLoadBalancerFromNetworkParams
  struct for passing parameters to the method detach_load_balancer_from_network
• DisablePublicInterfaceOfLoadBalancerParams
  struct for passing parameters to the method disable_public_interface_of_load_balancer
• EnablePublicInterfaceOfLoadBalancerParams
  struct for passing parameters to the method enable_public_interface_of_load_balancer
• GetActionForLoadBalancerParams
  struct for passing parameters to the method get_action_for_load_balancer
• GetLoadBalancerActionParams
  struct for passing parameters to the method get_load_balancer_action
• GetLoadBalancerParams
  struct for passing parameters to the method get_load_balancer
• GetMetricsForLoadbalancerParams
  struct for passing parameters to the method get_metrics_for_loadbalancer
• ListActionsForLoadBalancerParams
  struct for passing parameters to the method list_actions_for_load_balancer
• ListLoadBalancerActionsParams
  struct for passing parameters to the method list_load_balancer_actions
• ListLoadBalancersParams
  struct for passing parameters to the method list_load_balancers
• RemoveTargetParams
  struct for passing parameters to the method remove_target
• ReplaceLoadBalancerParams
  struct for passing parameters to the method replace_load_balancer
• UpdateServiceParams
  struct for passing parameters to the method update_service

Enums

• AddServiceError
  struct for typed errors of method add_service
• AddTargetError
  struct for typed errors of method add_target
• AttachLoadBalancerToNetworkError
  struct for typed errors of method attach_load_balancer_to_network
• ChangeAlgorithmError
  struct for typed errors of method change_algorithm
• ChangeLoadBalancerProtectionError
  struct for typed errors of method change_load_balancer_protection
• ChangeReverseDnsEntryForThisLoadBalancerError
  struct for typed errors of method change_reverse_dns_entry_for_this_load_balancer
• ChangeTypeOfLoadBalancerError
  struct for typed errors of method change_type_of_load_balancer
• CreateLoadBalancerError
  struct for typed errors of method create_load_balancer
• DeleteLoadBalancerError
  struct for typed errors of method delete_load_balancer
• DeleteServiceError
  struct for typed errors of method delete_service
• DetachLoadBalancerFromNetworkError
  struct for typed errors of method detach_load_balancer_from_network
• DisablePublicInterfaceOfLoadBalancerError
  struct for typed errors of method disable_public_interface_of_load_balancer
• EnablePublicInterfaceOfLoadBalancerError
  struct for typed errors of method enable_public_interface_of_load_balancer
• GetActionForLoadBalancerError
  struct for typed errors of method get_action_for_load_balancer
• GetLoadBalancerActionError
  struct for typed errors of method get_load_balancer_action
• GetLoadBalancerError
  struct for typed errors of method get_load_balancer
• GetMetricsForLoadbalancerError
  struct for typed errors of method get_metrics_for_loadbalancer
• ListActionsForLoadBalancerError
  struct for typed errors of method list_actions_for_load_balancer
• ListLoadBalancerActionsError
  struct for typed errors of method list_load_balancer_actions
• ListLoadBalancersError
  struct for typed errors of method list_load_balancers
• RemoveTargetError
  struct for typed errors of method remove_target
• ReplaceLoadBalancerError
  struct for typed errors of method replace_load_balancer
• UpdateServiceError
  struct for typed errors of method update_service

Functions

• add_service
  Adds a service to a Load Balancer. #### Call specific error codes | Code | Description | |––––––––––––––|———————————————————| | source_port_already_used | The source port you are trying to add is already in use |
• add_target
  Adds a target to a Load Balancer. #### Call specific error codes | Code | Description | |—————————————–|—————————————————————————————————––| | cloud_resource_ip_not_allowed | The IP you are trying to add as a target belongs to a Hetzner Cloud resource | | ip_not_owned | The IP you are trying to add as a target is not owned by the Project owner | | load_balancer_not_attached_to_network | The Load Balancer is not attached to a network | | robot_unavailable | Robot was not available. The caller may retry the operation after a short delay. | | server_not_attached_to_network | The server you are trying to add as a target is not attached to the same network as the Load Balancer | | target_already_defined | The Load Balancer target you are trying to define is already defined |
• attach_load_balancer_to_network
  Attach a Load Balancer to a Network. Call specific error codes | Code | Description | |–––––––––––––––––|———————————————————————–| | load_balancer_already_attached | The Load Balancer is already attached to a network | | ip_not_available | The provided Network IP is not available | | no_subnet_available | No Subnet or IP is available for the Load Balancer within the network |
• change_algorithm
  Change the algorithm that determines to which target new requests are sent.
• change_load_balancer_protection
  Changes the protection configuration of a Load Balancer.
• change_reverse_dns_entry_for_this_load_balancer
  Changes the hostname that will appear when getting the hostname belonging to the public IPs (IPv4 and IPv6) of this Load Balancer. Floating IPs assigned to the Server are not affected by this.
• change_type_of_load_balancer
  Changes the type (Max Services, Max Targets and Max Connections) of a Load Balancer. Call specific error codes | Code | Description | |——————————|—————————————————————–| | invalid_load_balancer_type | The Load Balancer type does not fit for the given Load Balancer |
• create_load_balancer
  Creates a Load Balancer. #### Call specific error codes | Code | Description | |—————————————–|—————————————————————————————————––| | cloud_resource_ip_not_allowed | The IP you are trying to add as a target belongs to a Hetzner Cloud resource | | ip_not_owned | The IP is not owned by the owner of the project of the Load Balancer | | load_balancer_not_attached_to_network | The Load Balancer is not attached to a network | | robot_unavailable | Robot was not available. The caller may retry the operation after a short delay. | | server_not_attached_to_network | The server you are trying to add as a target is not attached to the same network as the Load Balancer | | source_port_already_used | The source port you are trying to add is already in use | | target_already_defined | The Load Balancer target you are trying to define is already defined |
• delete_load_balancer
  Deletes a Load Balancer.
• delete_service
  Delete a service of a Load Balancer.
• detach_load_balancer_from_network
  Detaches a Load Balancer from a network.
• disable_public_interface_of_load_balancer
  Disable the public interface of a Load Balancer. The Load Balancer will be not accessible from the internet via its public IPs. #### Call specific error codes | Code | Description | |—————————————––|––––––––––––––––––––––––––––––––––––––––| | load_balancer_not_attached_to_network | The Load Balancer is not attached to a network | | targets_without_use_private_ip | The Load Balancer has targets that use the public IP instead of the private IP |
• enable_public_interface_of_load_balancer
  Enable the public interface of a Load Balancer. The Load Balancer will be accessible from the internet via its public IPs.
• get_action_for_load_balancer
  Returns a specific Action for a Load Balancer.
• get_load_balancer
  Gets a specific Load Balancer object.
• get_load_balancer_action
  Returns a specific Action object.
• get_metrics_for_loadbalancer
  You must specify the type of metric to get: open_connections, connections_per_second, requests_per_second or bandwidth. You can also specify more than one type by comma separation, e.g. requests_per_second,bandwidth. Depending on the type you will get different time series data: |Type | Timeseries | Unit | Description | |–– |————|——|———––| | open_connections | open_connections | number | Open connections | | connections_per_second | connections_per_second | connections/s | Connections per second | | requests_per_second | requests_per_second | requests/s | Requests per second | | bandwidth | bandwidth.in | bytes/s | Ingress bandwidth | || bandwidth.out | bytes/s | Egress bandwidth | Metrics are available for the last 30 days only. If you do not provide the step argument we will automatically adjust it so that 200 samples are returned. We limit the number of samples to a maximum of 500 and will adjust the step parameter accordingly.
• list_actions_for_load_balancer
  Returns all Action objects for a Load Balancer. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
• list_load_balancer_actions
  Returns all Action objects. You can sort the results by using the sort URI parameter, and filter them with the status and id parameter.
• list_load_balancers
  Gets all existing Load Balancers that you have available.
• remove_target
  Removes a target from a Load Balancer.
• replace_load_balancer
  Updates a Load Balancer. You can update a Load Balancer’s name and a Load Balancer’s labels. Note that when updating labels, the Load Balancer’s current set of labels will be replaced with the labels provided in the request body. So, for example, if you want to add a new label, you have to provide all existing labels plus the new label in the request body. Note: if the Load Balancer object changes during the request, the response will be a “conflict” error.
• update_service
  Updates a Load Balancer Service. #### Call specific error codes | Code | Description | |––––––––––––––|———————————————————| | source_port_already_used | The source port you are trying to add is already in use |