Load Balancer Interface

This page describes operations you can perform on load_balancer_interfaces. List, get details for, and update.

List Load Balancer Interface

List all visible load_balancer_interfaces.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/load_balancer_interfaces

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description the Load Balancer Interface no
id query string uuid - Unique ID of the Load Balancer Interface no
ip_address query string ipv4 - IP Address no
load_balancer_id query string hyph-uuid - The ID of load_balancer this load_balancer_interface belongs to. no
name query string - - Name of the Load Balancer Interface no
network_id query string hyph-uuid - Network no
slot_number query integer - - Slot Number no
status query string - - Load Balancer Interface status no
tenant_id query string uuid - Tenant ID of the owner (UUID) no
virtual_ip_address query string ipv4 - Virtual IP Address no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
load_balancer_interfaces array<object> Load Balancer Interface -
description string - Description the Load Balancer Interface
id string uuid Unique ID of the Load Balancer Interface
ip_address string ipv4 IP Address
load_balancer_id string hyph-uuid The ID of load_balancer this load_balancer_interface belongs to.
name string - Name of the Load Balancer Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Load Balancer Interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "load_balancer_interfaces": [
    {
      "description": "test",
      "id": "2897f333-3554-4099-a638-64d7022bf9ae",
      "ip_address": "100.64.64.34",
      "load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
      "name": "Interface 1/2",
      "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
      "slot_number": 2,
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "virtual_ip_address": "100.64.64.101",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 10
      }
    },
    {
      "description": "test",
      "id": "2b8c696e-0b86-4111-ad9a-bb4c4e166791",
      "ip_address": null,
      "load_balancer_id": "d80df2f1-75c9-49b9-bad1-31211b9c70a5",
      "name": "Interface 1/1",
      "network_id": null,
      "slot_number": 1,
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "virtual_ip_address": null,
      "virtual_ip_properties": null
    }
  ]
}

Show Load Balancer Interface

Show details for load_balancer_interface.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/load_balancer_interfaces/{load_balancer_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
load_balancer_interface_id URI string hyph-uuid - Unique ID of the Load Balancer Interface yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
load_balancer_interface object Load Balancer Interface -
description string - Description the Load Balancer Interface
id string uuid Unique ID of the Load Balancer Interface
ip_address string ipv4 IP Address
load_balancer_id string hyph-uuid The ID of load_balancer this load_balancer_interface belongs to.
name string - Name of the Load Balancer Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Load Balancer Interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "load_balancer_interface": {
    "description": "test",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.34",
    "load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "name": "Interface 1/2",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.101",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Update Load Balancer Interface

Update load_balancer_interface.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/load_balancer_interfaces/{load_balancer_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
load_balancer_interface_id URI string hyph-uuid - Unique ID of the Load Balancer Interface yes
load_balancer_interface plain object Load Balancer Interface - - yes
description plain string - - Description the Load Balancer Interface no
ip_address plain string ipv4 - IP Address no
name plain string - - Name of the Load Balancer Interface no
network_id plain string hyph-uuid - Network no
virtual_ip_address plain string ipv4 - Virtual IP Address no
virtual_ip_properties plain object - - Properties used for virtual IP address no
virtual_ip_properties.protocol plain string - [‘vrrp’] Redundancy Protocol no
virtual_ip_properties.vrid plain integer - - VRRP group identifier no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
load_balancer_interface object Load Balancer Interface -
description string - Description the Load Balancer Interface
id string uuid Unique ID of the Load Balancer Interface
ip_address string ipv4 IP Address
load_balancer_id string hyph-uuid The ID of load_balancer this load_balancer_interface belongs to.
name string - Name of the Load Balancer Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Load Balancer Interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

{
  "load_balancer_interface": {
    "description": "test",
    "ip_address": "100.64.64.34",
    "name": "Interface 1/2",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "virtual_ip_address": "100.64.64.101",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Sample Response Body

{
  "load_balancer_interface": {
    "description": "test",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.34",
    "load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "name": "Interface 1/2",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.101",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}