• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. LBaas
  6. Introduction

Introduction

Object

Interfaces used to manage or perform operations on load balancers, including querying load balancer details, querying load balancer status trees, querying load balancers, creating, deleting, and updating a load balancer

Interfaces used to manage or perform operations on listeners, including querying a listener, querying listeners, creating a listener, deleting a listener, and updating a listener

Interfaces used to manage or perform operations on pools, including querying a pool, querying pools, create a pool, delete a pool, and update a pool

Interfaces used to manage or perform operations on members, including querying a member, querying members, create a member, delete a member, and update a member

Interfaces used to manage or perform operations on health checks, including querying a health check, querying health checks, create a health check, delete a health check, and update a health check

Object Model

Table 1 Load balancer objects

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

Specifies the load balancer ID.

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID.

name

String(255)

CRU

N/A

N/A

Specifies the load balancer name.

description

String(255)

CRU

N/A

N/A

Provides supplementary information about the load balancer.

vip_subnet_id

uuid-str

CR

N/A

N/A

Specifies the ID of the subnet to which a VIP is assigned.

Only an internal network is supported.

vip_port_id

uuid-str

R

N/A

N/A

Specifies the ID of the VIP port.

provider

String

CR

N/A

N/A

Specifies the provider.

The value can only be vlb.

vip_address

String(64)

CR

N/A

N/A

Specifies the IP address of the VIP.

listeners

uuid-list

R

N/A

N/A

Specifies the list of listeners.

provisioning_status

String

R

N/A

N/A

Specifies the provisioning status. The value can be ACTIVEPENDING_CREATE, or ERROR.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINE, or DISABLED.

admin_state_up

Bool

CRU

true

N/A

Specifies the administrative status. The value can be true or false.

The value is true.

flavor_id

String(255)

CR

N/A

N/A

Specifies the flavor ID.

This parameter is unavailable.

Table 2 Listener objects

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

listener ID

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID.

name

String(255)

CRU

N/A

N/A

Specifies the listener name.

description

String(255)

CRU

N/A

N/A

Provides supplementary information about the listener.

protocol

String

CR

N/A

N/A

Specifies the listener protocol.

The protocol can be TCP or HTTP.

protocol_port

Int

CR

N/A

N/A

Specifies the listening port. The value ranges from 0 to 65535. When protocol is set to TCP, the value of protocol_port ranges from 0 to 65535. When protocol is set to HTTP, the value of protocol_port ranges from 1 to 65535.

loadbalancers

uuid-list

R

N/A

N/A

Specifies the list of load balancers bound to the listener.

connection_limit

Int

CRU

-1

N/A

Specifies the maximum number of connections. The value ranges from -1 to 2147483647.

admin_state_up

Bool

CRU

true

N/A

Specifies the administrative status. The value can be true or false.

The value is true.

default_pool_id

uuid

R

N/A

N/A

Specifies the ID of the pool associated with a listener.

default_tls_container_ref

String

CRU

N/A

N/A

Specifies the TLS secrets container.

This parameter is unavailable.

sni_container_refs

List(String)

CRU

N/A

N/A

Specifies the list of TLS secrets containers.

This parameter is unavailable.

Table 3 Pool objects

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

pool ID

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID.

name

String(255)

CRU

N/A

N/A

Specifies the pool name.

description

String(255)

CRU

N/A

N/A

Provides supplementary information about the pool.

protocol

String

CR

N/A

N/A

Specifies the backend protocol.

The protocol can be TCP or HTTP, and must be the same as that used by the listener.

lb_algorithm

String

CRU

N/A

N/A

Specifies the load balancing algorithm. The value can be ROUND_ROBINLEAST_CONNECTIONS, or SOURCE_IP.

members

uuid-list

R

N/A

N/A

Specifies the list of backend members.

healthmonitor_id

uuid

R

N/A

N/A

Specifies the health check UUID.

admin_state_up

Bool

CRU

true

N/A

Specifies the administrative status. The value can be true or false.

The value is true.

listener_id

uuid

CR

N/A

N/A

Specifies the ID of the listener associated with a pool.

listeners

uuid-list

R

N/A

N/A

Specifies the list of listeners associated with a pool.

session_persistence

Dict

CRU

N/A

N/A

Specifies the session persistence. For details, see Table 4.

Table 4 session_persistence object

Attribute

Type

CRUD

Default Value

Restriction

Description

type

String

CRU

N/A

N/A

Specifies the type of session persistence. The value can be SOURCE_IPHTTP_COOKIE, or APP_COOKIE.

cookie_name

String

CRU

N/A

N/A

Specifies the cookie name.

This parameter is available only when type is set to APP_COOKIE.

Table 5 Member object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

member ID

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID.

name

String(255)

CRU

N/A

N/A

Specifies the member name.

address

String(64)

CR

N/A

N/A

Specifies the IP address of the member, such as 192.168.3.11.

The value can only be the IP address of a primary NIC.

protocol_port

Int

CR

N/A

N/A

Specifies the back end protocol ID. The value ranges from 0 to 65535. Port 0 is valid only in DR mode.

subnet_id

uuid-str

CR

N/A

N/A

Specifies the subnet ID.

admin_state_up

Bool

CRU

true

N/A

Specifies the administrative status. The value can be true or false.

The value is true.

weight

Int

CRU

1

N/A

Specifies the weight. The value ranges from 0 to 256.

Table 6 Health check object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

Specifies the health check task ID.

tenant_id

String(255)

CR

N/A

N/A

Specifies the tenant ID.

name

String(255)

CRU

N/A

N/A

Specifies the health check name.

delay

Int

CRU

N/A

N/A

Specifies the health check interval (s). The value ranges from 0 to 2147483647.

max_retries

Int

CRU

N/A

N/A

Specifies the maximum number of failures. The value ranges from 1 to 10.

pools

uuid-list

R

N/A

N/A

Specifies the list of pool IDs.

pool_id

uuid

CR

N/A

N/A

pool id

admin_state_up

Bool

CRU

true

N/A

Specifies the administrative status. The value can be true or false.

The value is true.

timeout

Int

CRU

N/A

N/A

Specifies the timeout duration (s). The value ranges from 0 to 2147483647.

It is recommended that the value is less than that of delay.

type

String

CR

N/A

N/A

Specifies the type. The value can be PINGTCPHTTP, or HTTPS.

Type PING is valid only in DR mode. Type HTTPS is valid only in non-DR mode and when the listener protocol is TCP.

expected_codes

String

CRU

200

N/A

Specifies the expected HTTP response status code. The code value can be the following value: a specific value, for example, 200; a list of values that are separated with a comma (,), for example, 200, 202; a value range, for example, 200-204.

url_path

String

CRU

/

N/A

Specifies the HTTP request path for the member health check.

The value must start with /.

http_method

String

CRU

GET

N/A

Specifies the HTTP method. The value can be GETHEADPOSTPUTDELETETRACEOPTIONSCONNECT, and PATCH.

Table 7 Status object

Attribute

Type

CRUD

Default Value

Restriction

Description

loadbalancer

Dict

R

N/A

N/A

Specifies the load balancer status. For details, see Table 8.

Table 8 Load balancer status object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

Specifies the load balancer ID.

name

String(255)

R

N/A

N/A

Specifies the load balancer name.

listeners

list(listener)

R

N/A

N/A

Specifies the list of listeners. For details, see Table 9.

pools

list(pool)

R

N/A

N/A

Specifies the list of pools. For details, see Table 10.

provisioning_status

String

R

N/A

N/A

Specifies the provisioning status. The value can be ACTIVEPENDING_CREATE, or ERROR.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINEDEGRADEDDISABLED, or NO_MONITOR.

Table 9 Listener status object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

listener ID

name

String(255)

R

N/A

N/A

Specifies the listener name.

l7policies

list

R

N/A

N/A

This attribute is not supported.

pools

list(pool)

R

N/A

N/A

Specifies the list of pools. For details, see Table 10.

provisioning_status

String

R

N/A

N/A

Specifies the provisioning status. The value can be ACTIVEPENDING_CREATE, or ERROR.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINEDEGRADEDDISABLED, or NO_MONITOR.

Table 10 Pool status object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

pool ID

name

String(255)

R

N/A

N/A

Specifies the pool name.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINEDEGRADEDDISABLED, or NO_MONITOR.

provisioning_status

String

R

N/A

N/A

Specifies the provisioning status. The value can be ACTIVEPENDING_CREATE, or ERROR.

healthmonitor

Dict

R

N/A

N/A

Specifies the health check. For details, see Table 12.

members

list(member)

R

N/A

N/A

Specifies the list of members. For details, see Table 11.

Table 11 Member status object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

member ID

address

String(64)

R

N/A

N/A

Specifies the IP address of the member, such as 192.168.3.11.

protocol_port

Int

R

N/A

N/A

Specifies the backend protocol number.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINE, or DISABLED.

provisioning_status

String

R

N/A

N/A

Specifies the provisioning status. The value can be ACTIVEPENDING_CREATE, or ERROR.

Table 12 Health check status object

Attribute

Type

CRUD

Default Value

Restriction

Description

id

uuid-str

R

Automatically generated

N/A

Specifies the health check task ID.

name

String(255)

R

N/A

N/A

Specifies the health check name.

type

String

R

N/A

N/A

Specifies the type. The value can be PINGTCPHTTP, or HTTPS.

operating_status

String

R

N/A

N/A

Specifies the operating status. The value can be ONLINEOFFLINEDEGRADEDDISABLED, or NO_MONITOR.