Get Load Balancer Options

GET 
/backend/api/openstack/lbaas-load-balancers/create_options

Host: https://core.ocplanet.cloud

Retrieve options for creating a new LBAAS listener within the Load Balancer as a Service context. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Request

Responses

200

application/json

Schema

Schema

availability_zones arrayrequired
certificates arrayrequired
flavors arrayrequired
listener_protocols string[]required
monitor_http_methods objectrequired
CONNECT stringrequired
DELETE stringrequired
GET stringrequired
HEAD stringrequired
OPTIONS stringrequired
PATCH stringrequired
POST stringrequired
PUT stringrequired
TRACE stringrequired
monitor_types objectrequired
HTTP stringrequired
HTTPS stringrequired
PING stringrequired
SCTP stringrequired
TCP stringrequired
TLS-HELLO stringrequired
UDP-CONNECT stringrequired
pool_algorithms objectrequired
LEAST_CONNECTIONS stringrequired
ROUND_ROBIN stringrequired
SOURCE_IP stringrequired
SOURCE_IP_PORT stringrequired
pool_protocols string[]required
pool_supported_algorithms string[]required
protocols objectrequired
HTTP stringrequired
HTTPS stringrequired
PROXY stringrequired
PROXYV2 stringrequired
SCTP stringrequired
TCP stringrequired
TERMINATED_HTTPS stringrequired
UDP stringrequired
session_persistence_types objectrequired
APP_COOKIE stringrequired
HTTP_COOKIE stringrequired
SOURCE_IP stringrequired
subnets object[]required
Array [
allocation_pools stringrequired
cidr stringrequired
created_at stringrequired
description stringrequired
enable_dhcp booleanrequired
extra stringrequired
gateway_ip stringrequired
id stringrequired
ip_version integerrequired
name stringrequired
network stringrequired
network_name stringrequired
project stringrequired
subnetpool_id nullrequired
updated_at stringrequired
]

Example (from schema)

{
  "availability_zones": [
    null
  ],
  "certificates": [
    null
  ],
  "flavors": [
    null
  ],
  "listener_protocols": [
    "string"
  ],
  "monitor_http_methods": {
    "CONNECT": "string",
    "DELETE": "string",
    "GET": "string",
    "HEAD": "string",
    "OPTIONS": "string",
    "PATCH": "string",
    "POST": "string",
    "PUT": "string",
    "TRACE": "string"
  },
  "monitor_types": {
    "HTTP": "string",
    "HTTPS": "string",
    "PING": "string",
    "SCTP": "string",
    "TCP": "string",
    "TLS-HELLO": "string",
    "UDP-CONNECT": "string"
  },
  "pool_algorithms": {
    "LEAST_CONNECTIONS": "string",
    "ROUND_ROBIN": "string",
    "SOURCE_IP": "string",
    "SOURCE_IP_PORT": "string"
  },
  "pool_protocols": [
    "string"
  ],
  "pool_supported_algorithms": [
    "string"
  ],
  "protocols": {
    "HTTP": "string",
    "HTTPS": "string",
    "PROXY": "string",
    "PROXYV2": "string",
    "SCTP": "string",
    "TCP": "string",
    "TERMINATED_HTTPS": "string",
    "UDP": "string"
  },
  "session_persistence_types": {
    "APP_COOKIE": "string",
    "HTTP_COOKIE": "string",
    "SOURCE_IP": "string"
  },
  "subnets": [
    {
      "allocation_pools": "string",
      "cidr": "string",
      "created_at": "string",
      "description": "string",
      "enable_dhcp": true,
      "extra": "string",
      "gateway_ip": "string",
      "id": "string",
      "ip_version": 0,
      "name": "string",
      "network": "string",
      "network_name": "string",
      "project": "string",
      "updated_at": "string"
    }
  ]
}

Example

{
  "flavors": [],
  "availability_zones": [],
  "protocols": {
    "TCP": "TCP",
    "UDP": "UDP",
    "HTTP": "HTTP",
    "HTTPS": "HTTPS",
    "TERMINATED_HTTPS": "TERMINATED_HTTPS",
    "PROXY": "PROXY",
    "PROXYV2": "PROXYV2",
    "SCTP": "SCTP"
  },
  "subnets": [
    {
      "id": "d34c6f4d-35c0-46d5-8c9e-c35244c8bc28",
      "network_name": "network72670",
      "name": "subnet62473",
      "description": "",
      "subnetpool_id": null,
      "ip_version": 4,
      "gateway_ip": "10.0.1.1",
      "cidr": "10.0.1.0/24",
      "enable_dhcp": true,
      "created_at": "2024-03-21T08:01:47Z",
      "updated_at": "2024-03-21T08:01:47Z",
      "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
      "allocation_pools": "[{'start': '10.0.1.2', 'end': '10.0.1.254'}]",
      "network": "71075cf9-9be2-4b2e-8165-d2fa36bb87b7",
      "project": "41e4ce1e550a4b4c922db7c287cf5a53"
    },
    {
      "id": "0fdc384b-75e5-447e-8330-540e6527c268",
      "network_name": "network42973",
      "name": "subnet22781",
      "description": "",
      "subnetpool_id": null,
      "ip_version": 4,
      "gateway_ip": "10.0.1.1",
      "cidr": "10.0.1.0/24",
      "enable_dhcp": true,
      "created_at": "2024-03-20T13:47:20Z",
      "updated_at": "2024-03-20T13:47:20Z",
      "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
      "allocation_pools": "[{'start': '10.0.1.2', 'end': '10.0.1.254'}]",
      "network": "6e9089b0-953e-4846-9840-f0605d880a1c",
      "project": "41e4ce1e550a4b4c922db7c287cf5a53"
    },
    {
      "id": "9a9da325-4314-4b67-8996-250b6c9fadba",
      "network_name": "network71275",
      "name": "subnet99981",
      "description": "",
      "subnetpool_id": null,
      "ip_version": 4,
      "gateway_ip": "10.0.1.1",
      "cidr": "10.0.1.0/24",
      "enable_dhcp": true,
      "created_at": "2024-03-18T14:31:43Z",
      "updated_at": "2024-03-19T07:26:12Z",
      "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
      "allocation_pools": "[]",
      "network": "fdd1339c-423e-481e-bc9f-1b9d2a60edce",
      "project": "41e4ce1e550a4b4c922db7c287cf5a53"
    },
    {
      "id": "b968f4d5-9586-442a-996d-da570a4a6d9d",
      "network_name": "network60199a",
      "name": "subnet41914",
      "description": "",
      "subnetpool_id": null,
      "ip_version": 4,
      "gateway_ip": "10.0.1.1",
      "cidr": "10.0.1.0/24",
      "enable_dhcp": true,
      "created_at": "2024-02-28T07:37:05Z",
      "updated_at": "2024-03-18T14:21:40Z",
      "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
      "allocation_pools": "[]",
      "network": "ac280db2-cf06-49d4-94bd-66b5c0167dc4",
      "project": "41e4ce1e550a4b4c922db7c287cf5a53"
    },
    {
      "id": "7e21d26b-f92a-4265-a073-c4abef1fbd9b",
      "network_name": "external_network",
      "name": "external_subnet1",
      "description": "",
      "subnetpool_id": null,
      "ip_version": 4,
      "gateway_ip": "2.59.220.1",
      "cidr": "2.59.220.0/22",
      "enable_dhcp": false,
      "created_at": "2022-02-11T20:20:04Z",
      "updated_at": "2024-03-14T11:10:23Z",
      "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
      "allocation_pools": "[{'start': '2.59.220.215', 'end': '2.59.220.254'}, {'start': '2.59.223.2', 'end': '2.59.223.253'}, {'start': '2.59.221.140', 'end': '2.59.221.254'}]",
      "network": "5cf72c55-b9cd-4706-862a-6bc4c3e41bfc",
      "project": "c712e3d141fa4a20b393320ac2bd1065"
    }
  ],
  "listener_protocols": [
    "TCP",
    "HTTP",
    "HTTPS",
    "TERMINATED_HTTPS",
    "UDP"
  ],
  "pool_protocols": [
    "TCP",
    "HTTP",
    "HTTPS",
    "PROXY",
    "PROXYV2",
    "UDP",
    "SCTP"
  ],
  "pool_algorithms": {
    "ROUND_ROBIN": "Циклічний обіг",
    "LEAST_CONNECTIONS": "Найменше зв'язків",
    "SOURCE_IP": "Джерело IP",
    "SOURCE_IP_PORT": "Вихідний IP-порт"
  },
  "pool_supported_algorithms": [
    "LEAST_CONNECTIONS",
    "ROUND_ROBIN",
    "SOURCE_IP"
  ],
  "session_persistence_types": {
    "SOURCE_IP": "Джерело IP",
    "HTTP_COOKIE": "HTTP cookie",
    "APP_COOKIE": "Cookie програми"
  },
  "monitor_types": {
    "PING": "Пінг",
    "TCP": "TCP",
    "HTTP": "HTTP",
    "HTTPS": "HTTPS",
    "TLS-HELLO": "TLS-HELLO",
    "UDP-CONNECT": "UDP-CONNECT",
    "SCTP": "SCTP"
  },
  "monitor_http_methods": {
    "GET": "GET",
    "HEAD": "HEAD",
    "POST": "POST",
    "PUT": "PUT",
    "DELETE": "DELETE",
    "TRACE": "TRACE",
    "OPTIONS": "OPTIONS",
    "CONNECT": "CONNECT",
    "PATCH": "PATCH"
  },
  "certificates": []
}

Loading...