Load Balancer

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

List Load Balancer

List all visible load_balancers.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/load_balancers

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
admin_username	query	string	-	-	Username with admin access to VM instance	no
availability_zone	query	string	-	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones	no
default_gateway	query	string	ipv4	-	IP address of default gateway	no
description	query	string	-	-	Description of the Load Balancer	no
id	query	string	hyph-uuid	-	Unique ID of the Load Balancer	no
load_balancer_plan_id	query	string	hyph-uuid	-	Load Balancer Plan	no
name	query	string	-	-	Name of the Load Balancer	no
status	query	string	-	-	The Load Balancer status.	no
tenant_id	query	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	no
user_username	query	string	-	-	Username with user access to VM instance	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_balancers	array<object>	datatype_load_balancer	-
admin_username	string	-	Username with admin access to VM instance
availability_zone	string	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones
default_gateway	string	ipv4	IP address of default gateway
description	string	-	Description of the Load Balancer
id	string	hyph-uuid	Unique ID of the Load Balancer
load_balancer_plan_id	string	hyph-uuid	Load Balancer Plan
name	string	-	Name of the Load Balancer
status	string	-	The Load Balancer status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
user_username	string	-	Username with user access to VM instance

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "load_balancers": [
    {
      "admin_username": "user-admin",
      "availability_zone": "zone1-groupa",
      "default_gateway": null,
      "description": "abcdefghijklmnopqrstuvwxyz",
      "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
      "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
      "name": "abcdefghijklmnopqrstuvwxyz",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "user_username": "user-read"
    },
    {
      "admin_username": "user-admin",
      "availability_zone": "zone1_groupa",
      "default_gateway": null,
      "description": "abcdefghijklmnopqrstuvwxyz",
      "id": "601665cf-c161-4e80-87f0-a3c0925d07a0",
      "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
      "name": "abcdefghijklmnopqrstuvwxyz",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "user_username": "user-read"
    }
  ]
}

Create Load Balancer

Create load_balancer.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• POST

HTTP Request Path

{endpoint}/v2.0/load_balancers

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
load_balancer	plain	object	datatype_load_balancer	-	-	-	yes
availability_zone	plain	string	-	-	null	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones	no
description	plain	string	-	-	""	Description of the Load Balancer	no
load_balancer_plan_id	plain	string	hyph-uuid	-	-	Load Balancer Plan	yes
name	plain	string	-	-	""	Name of the Load Balancer	no
tenant_id	plain	string	non-hyph-uuid	-	See notes.	Tenant ID of the owner (UUID)	no

注釈

tenant_id: The ID of default tenant to which user belongs.

Response

HTTP Response Code List

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

HTTP Response Parameters

Parameter	Type	Format	Description
load_balancer	object	datatype_load_balancer	-
admin_username	string	-	Username with admin access to VM instance
availability_zone	string	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones
description	string	-	Description of the Load Balancer
id	string	hyph-uuid	Unique ID of the Load Balancer
interfaces	array<object>	-	Attached interfaces
id	string	-	-
ip_address	string	-	-
name	string	-	-
network_id	string	-	-
slot_number	integer	-	-
status	string	-	-
load_balancer_plan_id	string	hyph-uuid	Load Balancer Plan
name	string	-	Name of the Load Balancer
status	string	-	The Load Balancer status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
user_username	string	-	Username with user access to VM instance

Examples

Sample Request Body

{
  "load_balancer": {
    "availability_zone": "zone1-groupa",
    "description": "abcdefghijklmnopqrstuvwxyz",
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "load_balancer": {
    "admin_username": "user-admin",
    "availability_zone": "zone1-groupa",
    "description": "abcdefghijklmnopqrstuvwxyz",
    "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
    "interfaces": [
      {
        "id": "ee335c69-b50f-4a32-9d0f-f44cef84a456",
        "ip_address": "100.127.253.173",
        "name": "Interface 1/1",
        "network_id": "c7f88fab-573e-47aa-b0b4-257db28dae23",
        "slot_number": 1,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "b39b61e4-00b1-4698-aed0-1928beb90abe",
        "ip_address": "192.168.110.1",
        "name": "Interface 1/2",
        "network_id": "1839d290-721c-49ba-99f1-3d7aa37811b0",
        "slot_number": 2,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "e1bede1c-68df-4adb-92ff-bc79cb5ff4c9",
        "ip_address": "192.168.3.4",
        "name": "Interface 1/3",
        "network_id": "bc4fe0f3-655c-49f8-b7e5-f3dccb2b920f",
        "slot_number": 3,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "1de97307-3a90-407b-be5a-1d104c664bcb",
        "ip_address": null,
        "name": "Interface 1/4",
        "network_id": null,
        "slot_number": 4,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      }
    ],
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz",
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "user_username": "user-read"
  }
}

Show Load Balancer

Show details for load_balancer.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/load_balancers/{load_balancer_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
load_balancer_id	URI	string	hyph-uuid	-	Unique ID of the Load Balancer	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	object	datatype_load_balancer	-
admin_username	string	-	Username with admin access to VM instance
availability_zone	string	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones
default_gateway	string	ipv4	IP address of default gateway
description	string	-	Description of the Load Balancer
id	string	hyph-uuid	Unique ID of the Load Balancer
interfaces	array<object>	-	Attached interfaces
id	string	-	-
ip_address	string	-	-
name	string	-	-
network_id	string	-	-
slot_number	integer	-	-
status	string	-	-
type	integer	-	-
load_balancer_plan_id	string	hyph-uuid	Load Balancer Plan
name	string	-	Name of the Load Balancer
status	string	-	The Load Balancer status.
syslog_servers	array<object>	-	Connected syslog servers
id	string	-	-
ip_address	string	-	-
log_facility	integer	-	-
log_level	string	-	-
name	string	-	-
port_number	integer	-	-
status	string	-	-
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
user_username	string	-	Username with user access to VM instance

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "load_balancer": {
    "admin_username": "user-admin",
    "availability_zone": "zone1-groupa",
    "default_gateway": null,
    "description": "abcdefghijklmnopqrstuvwxyz",
    "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
    "interfaces": [
      {
        "id": "ee335c69-b50f-4a32-9d0f-f44cef84a456",
        "ip_address": "100.127.253.173",
        "name": "Interface 1/1",
        "network_id": "c7f88fab-573e-47aa-b0b4-257db28dae23",
        "slot_number": 1,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "b39b61e4-00b1-4698-aed0-1928beb90abe",
        "ip_address": "192.168.110.1",
        "name": "Interface 1/2",
        "network_id": "1839d290-721c-49ba-99f1-3d7aa37811b0",
        "slot_number": 2,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "e1bede1c-68df-4adb-92ff-bc79cb5ff4c9",
        "ip_address": "192.168.3.4",
        "name": "Interface 1/3",
        "network_id": "bc4fe0f3-655c-49f8-b7e5-f3dccb2b920f",
        "slot_number": 3,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "1de97307-3a90-407b-be5a-1d104c664bcb",
        "ip_address": null,
        "name": "Interface 1/4",
        "network_id": null,
        "slot_number": 4,
        "status": "ACTIVE",
        "type": "user",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      }
    ],
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz",
    "status": "ACTIVE",
    "syslog_servers": [
      {
        "id": "11001101-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.215",
        "log_facility": "LOCAL0",
        "log_level": "ALERT|INFO|ERROR",
        "name": "syslog_server_main",
        "port_number": 514,
        "status": "ACTIVE"
      },
      {
        "id": "22002202-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.211",
        "log_facility": "LOCAL1",
        "log_level": "ERROR",
        "name": "syslog_server_backup_fst",
        "port_number": 514,
        "status": "ACTIVE"
      }
    ],
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "user_username": "user-read"
  }
}

Update Load Balancer

Update load_balancer.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• PUT

HTTP Request Path

{endpoint}/v2.0/load_balancers/{load_balancer_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
load_balancer_id	URI	string	hyph-uuid	-	Unique ID of the Load Balancer	yes
load_balancer	plain	object	datatype_load_balancer	-	-	yes
default_gateway	plain	string	ipv4	-	IP address of default gateway	no
description	plain	string	-	-	Description of the Load Balancer	no
load_balancer_plan_id	plain	string	hyph-uuid	-	Load Balancer Plan	no
name	plain	string	-	-	Name of the Load Balancer	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	object	datatype_load_balancer	-
admin_username	string	-	Username with admin access to VM instance
availability_zone	string	-	Availability Zone, this can be referred to using Virtual Server (Nova)'s list availability zones
default_gateway	string	ipv4	IP address of default gateway
description	string	-	Description of the Load Balancer
id	string	hyph-uuid	Unique ID of the Load Balancer
interfaces	array<object>	-	Attached interfaces
id	string	-	-
ip_address	string	-	-
name	string	-	-
network_id	string	-	-
slot_number	integer	-	-
status	string	-	-
load_balancer_plan_id	string	hyph-uuid	Load Balancer Plan
name	string	-	Name of the Load Balancer
status	string	-	The Load Balancer status.
syslog_servers	array<object>	-	Connected syslog servers
id	string	-	-
ip_address	string	-	-
log_facility	integer	-	-
log_level	string	-	-
name	string	-	-
port_number	integer	-	-
status	string	-	-
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
user_username	string	-	Username with user access to VM instance

Examples

Sample Request Body

{
  "load_balancer": {
    "default_gateway": null,
    "description": "abcdefghijklmnopqrstuvwxyz",
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz"
  }
}

Sample Response Body

{
  "load_balancer": {
    "admin_username": "user-admin",
    "availability_zone": "zone1-groupa",
    "default_gateway": null,
    "description": "abcdefghijklmnopqrstuvwxyz",
    "id": "5f3cae7c-58a5-4124-b622-9ca3cfbf2525",
    "interfaces": [
      {
        "id": "ee335c69-b50f-4a32-9d0f-f44cef84a456",
        "ip_address": "100.127.253.173",
        "name": "Interface 1/1",
        "network_id": "c7f88fab-573e-47aa-b0b4-257db28dae23",
        "slot_number": 1,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "b39b61e4-00b1-4698-aed0-1928beb90abe",
        "ip_address": "192.168.110.1",
        "name": "Interface 1/2",
        "network_id": "1839d290-721c-49ba-99f1-3d7aa37811b0",
        "slot_number": 2,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "e1bede1c-68df-4adb-92ff-bc79cb5ff4c9",
        "ip_address": "192.168.3.4",
        "name": "Interface 1/3",
        "network_id": "bc4fe0f3-655c-49f8-b7e5-f3dccb2b920f",
        "slot_number": 3,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      },
      {
        "id": "1de97307-3a90-407b-be5a-1d104c664bcb",
        "ip_address": null,
        "name": "Interface 1/4",
        "network_id": null,
        "slot_number": 4,
        "status": "ACTIVE",
        "virtual_ip_address": null,
        "virtual_ip_properties": null
      }
    ],
    "load_balancer_plan_id": "bd12784a-c66e-4f13-9f72-5143d64762b6",
    "name": "abcdefghijklmnopqrstuvwxyz",
    "status": "PENDING_UPDATE",
    "syslog_servers": [
      {
        "id": "11001101-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.215",
        "log_facility": "LOCAL0",
        "log_level": "ALERT|INFO|ERROR",
        "name": "syslog_server_main",
        "port_number": 514,
        "status": "ACTIVE"
      },
      {
        "id": "22002202-2edf-1844-1ff7-12ba5b7e566a",
        "ip_address": "177.77.07.211",
        "log_facility": "LOCAL1",
        "log_level": "ERROR",
        "name": "syslog_server_backup_fst",
        "port_number": 514,
        "status": "ACTIVE"
      }
    ],
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "user_username": "user-read"
  }
}

Delete Load Balancer

Delete load_balancer.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• DELETE

HTTP Request Path

{endpoint}/v2.0/load_balancers/{load_balancer_id}

HTTP Request Parameters

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

Response

HTTP Response Code List

Response Code	Description
204	No Content
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters

This operation does not receive a response body.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

This operation does not receive a response body.

目次

• Load Balancer Service
  • Load Balancer
  • Load Balancer Plan
  • Load Balancer Interface
  • Load Balancer Syslog Server
  • Load Balancer/Actions

• Revision History

---

Load Balancer Service

Load Balancer Plan