Load Balancing¶

Version:

2.27

Load Balancing API provided by Octavia service

lbaas¶

GET

/v2/lbaas

Responses¶

200¶

404¶

Error

load-balancers¶

GET

/v2/lbaas/loadbalancers/{loadbalancer_id}

Show Load Balancer details

Shows the details of a load balancer.

If you are not an administrative user and the load balancer object does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
loadbalancer	body	object	A load balancer object.
loadbalancer.id	body	string	The ID of the load balancer.
loadbalancer.name	body	string	Human-readable name of the resource.
loadbalancer.description	body	string	A human-readable description for the resource.
loadbalancer.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
loadbalancer.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
loadbalancer.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
loadbalancer.project_id	body	string	The ID of the project owning this resource.
loadbalancer.created_at	body	string	The UTC date and timestamp when the resource was created.
loadbalancer.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
loadbalancer.vip_address	body	string	The IP address of the Virtual IP (VIP).
loadbalancer.vip_port_id	body	string	The ID of the Virtual IP (VIP) port.
loadbalancer.vip_subnet_id	body	string	The ID of the subnet for the Virtual IP (VIP).
loadbalancer.vip_network_id	body	string	The ID of the network for the Virtual IP (VIP).
loadbalancer.provider	body	string	Provider name for the load balancer.
loadbalancer.flavor_id	body	string	The ID of the flavor.
loadbalancer.vip_qos_policy_id	body	string	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
loadbalancer.availability_zone	body	string	An availability zone name.
loadbalancer.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/loadbalancers/{loadbalancer_id}

Update a Load Balancer

Updates a load balancer.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the load balancer provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the load balancer object for changes.

This operation returns the updated load balancer object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
loadbalancer_id	path	string	loadbalancer_id parameter for /v2/lbaas/loadbalancers/{loadbalancer_id}/failover API
loadbalancer	body	object	A load balancer object.
loadbalancer.name	body	string	Human-readable name of the resource.
loadbalancer.description	body	string	A human-readable description for the resource.
loadbalancer.vip_qos_policy_id	body	string	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
loadbalancer.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "loadbalancer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "vip_qos_policy_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the QoS Policy which will apply to the Virtual IP (VIP)."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        }
      },
      "description": "A load balancer object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
loadbalancer	body	object	A load balancer object.
loadbalancer.id	body	string	The ID of the load balancer.
loadbalancer.name	body	string	Human-readable name of the resource.
loadbalancer.description	body	string	A human-readable description for the resource.
loadbalancer.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
loadbalancer.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
loadbalancer.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
loadbalancer.project_id	body	string	The ID of the project owning this resource.
loadbalancer.created_at	body	string	The UTC date and timestamp when the resource was created.
loadbalancer.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
loadbalancer.vip_address	body	string	The IP address of the Virtual IP (VIP).
loadbalancer.vip_port_id	body	string	The ID of the Virtual IP (VIP) port.
loadbalancer.vip_subnet_id	body	string	The ID of the subnet for the Virtual IP (VIP).
loadbalancer.vip_network_id	body	string	The ID of the network for the Virtual IP (VIP).
loadbalancer.provider	body	string	Provider name for the load balancer.
loadbalancer.flavor_id	body	string	The ID of the flavor.
loadbalancer.vip_qos_policy_id	body	string	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
loadbalancer.availability_zone	body	string
loadbalancer.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/loadbalancers/{loadbalancer_id}

Remove a Load Balancer

Removes a load balancer and its associated configuration from the project.

The optional parameter cascade when defined as true will delete all child objects of the load balancer.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/loadbalancers

List Load Balancers

Lists all load balancers for the project.

Use the fields query parameter to control which fields are returned in the response body. Additionally, you can filter results by using query string parameters. For information, see Filtering and column selection.

Administrative users can specify a project ID that is different than their own to list load balancers for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/loadbalancers

Create a Load Balancer

Creates a load balancer.

This operation provisions a new load balancer by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object that contains a unique ID and the status of provisioning the load balancer.

In the response, the load balancer provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/loadbalancers/{loadbalancer_id} to view the progress of the provisioning operation. When the load balancer status changes to ACTIVE, the load balancer is successfully provisioned and is ready for further configuration.

If the API cannot fulfill the request due to insufficient data or data that is not valid, the service returns the HTTP Bad Request (400) response code with information about the failure in the response body. Validation errors require that you correct the error and submit the request again.

Administrative users can specify a project ID that is different than their own to create load balancers for other projects.

An optional flavor_id attribute can be used to create the load balancer using a pre-configured octavia flavor. Flavors are created by the operator to allow custom load balancer configurations, such as allocating more memory for the load balancer.

An optional vip_qos_policy_id attribute from Neutron can be used to apply QoS policies on a loadbalancer VIP, also could pass a ‘null’ value to remove QoS policies.

You can also specify the provider attribute when you create a load balancer. The provider attribute specifies which backend should be used to create the load balancer. This could be the default provider (octavia) or a vendor supplied provider if one has been installed. Setting both a flavor_id and a provider will result in a conflict error if the provider does not match the provider of the configured flavor profiles.

Specifying a Virtual IP (VIP) is mandatory. There are three ways to specify a VIP network for the load balancer:

Additional VIPs may also be specified in the additional_vips field, by providing a list of JSON objects containing a subnet_id and optionally an ip_address. All additional subnets must be part of the same network as the primary VIP.

Request¶

Description

Name	Location	Type	Description
loadbalancer	body	object	A load balancer object.
loadbalancer.name	body	string	Human-readable name of the resource.
loadbalancer.description	body	string	A human-readable description for the resource.
loadbalancer.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
loadbalancer.vip_address	body	string	The IP address of the Virtual IP (VIP).
loadbalancer.vip_port_id	body	string	The ID of the Virtual IP (VIP) port. One of `vip_network_id`, `vip_port_id`, or `vip_subnet_id` must be specified.
loadbalancer.vip_subnet_id	body	string	The ID of the subnet for the Virtual IP (VIP). One of `vip_network_id`, `vip_port_id`, or `vip_subnet_id` must be specified.
loadbalancer.vip_network_id	body	string	The ID of the network for the Virtual IP (VIP). One of `vip_network_id`, `vip_port_id`, or `vip_subnet_id` must be specified.
loadbalancer.vip_qos_policy_id	body	string	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
loadbalancer.project_id	body	string	The ID of the project owning this resource.
loadbalancer.provider	body	string	Provider name for the load balancer. Default is `octavia`.
loadbalancer.flavor_id	body	string	The ID of the flavor.
loadbalancer.availability_zone	body	string	An availability zone name.
loadbalancer.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "loadbalancer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "vip_address": {
          "type": "string",
          "format": "ipaddress",
          "description": "The IP address of the Virtual IP (VIP)."
        },
        "vip_port_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the Virtual IP (VIP) port. One of `vip_network_id`,\n`vip_port_id`, or `vip_subnet_id` must be specified."
        },
        "vip_subnet_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the subnet for the Virtual IP (VIP). One of `vip_network_id`,\n`vip_port_id`, or `vip_subnet_id` must be specified."
        },
        "vip_network_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the network for the Virtual IP (VIP). One of `vip_network_id`,\n`vip_port_id`, or `vip_subnet_id` must be specified."
        },
        "vip_qos_policy_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the QoS Policy which will apply to the Virtual IP (VIP)."
        },
        "additional_vips": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "subnet_id": {
                "type": "string",
                "format": "uuid"
              },
              "ip_address": {
                "type": "string",
                "format": "ipaddress"
              }
            },
            "description": "Type for additional vips",
            "required": [
              "subnet_id"
            ]
          },
          "description": "A list of JSON objects defining \u201cadditional VIPs\u201d. The format for these\nis `{\"subnet_id\": <subnet_id>, \"ip_address\": <ip_address>}`, where\nthe `subnet_id` field is mandatory and the `ip_address` field is\noptional. Additional VIP subnets must all belong to the same network as\nthe primary VIP.\n\n\n**New in version 2.26**"
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource."
        },
        "listeners": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 255
              },
              "description": {
                "type": "string",
                "maxLength": 255
              },
              "admin_state_up": {
                "type": "boolean"
              },
              "protocol": {
                "type": "string",
                "enum": [
                  "HTTP",
                  "SCTP",
                  "TERMINATED_HTTPS",
                  "TCP",
                  "UDP",
                  "HTTPS",
                  "PROMETHEUS"
                ]
              },
              "protocol_port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "connection_limit": {
                "type": "integer",
                "minimum": -1
              },
              "default_tls_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "sni_container_refs": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "default_pool_id": {
                "type": "string",
                "format": "uuid"
              },
              "default_pool": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "admin_state_up": {
                    "type": "boolean"
                  },
                  "protocol": {
                    "type": "string",
                    "enum": [
                      "PROXY",
                      "HTTP",
                      "SCTP",
                      "TCP",
                      "UDP",
                      "HTTPS",
                      "PROXYV2"
                    ]
                  },
                  "lb_algorithm": {
                    "type": "string",
                    "enum": [
                      "ROUND_ROBIN",
                      "LEAST_CONNECTIONS",
                      "SOURCE_IP_PORT",
                      "SOURCE_IP"
                    ]
                  },
                  "session_persistence": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "HTTP_COOKIE",
                          "SOURCE_IP",
                          "APP_COOKIE"
                        ]
                      },
                      "cookie_name": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "persistence_timeout": {
                        "type": "integer"
                      },
                      "persistence_granularity": {
                        "type": "string",
                        "format": "ipaddress"
                      }
                    },
                    "description": "Defines mandatory and optional attributes of a POST request.",
                    "required": [
                      "type"
                    ]
                  },
                  "healthmonitor": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "HTTP",
                          "SCTP",
                          "UDP-CONNECT",
                          "TLS-HELLO",
                          "TCP",
                          "HTTPS",
                          "PING"
                        ]
                      },
                      "delay": {
                        "type": "integer"
                      },
                      "timeout": {
                        "type": "integer"
                      },
                      "max_retries_down": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 10
                      },
                      "max_retries": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 10
                      },
                      "http_method": {
                        "type": "string",
                        "enum": [
                          "HEAD",
                          "POST",
                          "CONNECT",
                          "OPTIONS",
                          "PATCH",
                          "PUT",
                          "DELETE",
                          "TRACE",
                          "GET"
                        ]
                      },
                      "url_path": {
                        "type": "string",
                        "format": "url_path"
                      },
                      "expected_codes": {
                        "type": "string"
                      },
                      "admin_state_up": {
                        "type": "boolean"
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
                      },
                      "http_version": {
                        "type": "number",
                        "enum": [
                          1.0,
                          1.1
                        ]
                      },
                      "domain_name": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    },
                    "description": "Defines mandatory and optional attributes of a POST request.",
                    "required": [
                      "delay",
                      "timeout",
                      "max_retries",
                      "type"
                    ]
                  },
                  "members": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "admin_state_up": {
                          "type": "boolean"
                        },
                        "address": {
                          "type": "string",
                          "format": "ipaddress"
                        },
                        "protocol_port": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 65535
                        },
                        "weight": {
                          "type": "integer",
                          "maximum": 256
                        },
                        "backup": {
                          "type": "boolean"
                        },
                        "subnet_id": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "monitor_port": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 65535
                        },
                        "monitor_address": {
                          "type": "string",
                          "format": "ipaddress"
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "maxLength": 255
                          }
                        }
                      },
                      "description": "Defines mandatory and optional attributes of a POST request.",
                      "required": [
                        "protocol_port",
                        "address"
                      ]
                    }
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "tls_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "ca_tls_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "crl_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "tls_enabled": {
                    "type": "boolean"
                  },
                  "tls_ciphers": {
                    "type": "string",
                    "maxLength": 2048
                  },
                  "tls_versions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 32
                    }
                  },
                  "alpn_protocols": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "alpn_protocol"
                    }
                  }
                },
                "description": "Defines mandatory and optional attributes of a POST request."
              },
              "l7policies": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "description": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "admin_state_up": {
                      "type": "boolean"
                    },
                    "action": {
                      "type": "string",
                      "enum": [
                        "REDIRECT_TO_URL",
                        "REDIRECT_PREFIX",
                        "REJECT",
                        "REDIRECT_TO_POOL"
                      ]
                    },
                    "redirect_pool": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "description": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "admin_state_up": {
                          "type": "boolean"
                        },
                        "protocol": {
                          "type": "string",
                          "enum": [
                            "PROXY",
                            "HTTP",
                            "SCTP",
                            "TCP",
                            "UDP",
                            "HTTPS",
                            "PROXYV2"
                          ]
                        },
                        "lb_algorithm": {
                          "type": "string",
                          "enum": [
                            "ROUND_ROBIN",
                            "LEAST_CONNECTIONS",
                            "SOURCE_IP_PORT",
                            "SOURCE_IP"
                          ]
                        },
                        "session_persistence": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "HTTP_COOKIE",
                                "SOURCE_IP",
                                "APP_COOKIE"
                              ]
                            },
                            "cookie_name": {
                              "type": "string",
                              "maxLength": 255
                            },
                            "persistence_timeout": {
                              "type": "integer"
                            },
                            "persistence_granularity": {
                              "type": "string",
                              "format": "ipaddress"
                            }
                          },
                          "description": "Defines mandatory and optional attributes of a POST request.",
                          "required": [
                            "type"
                          ]
                        },
                        "healthmonitor": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "maxLength": 255
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "HTTP",
                                "SCTP",
                                "UDP-CONNECT",
                                "TLS-HELLO",
                                "TCP",
                                "HTTPS",
                                "PING"
                              ]
                            },
                            "delay": {
                              "type": "integer"
                            },
                            "timeout": {
                              "type": "integer"
                            },
                            "max_retries_down": {
                              "type": "integer",
                              "minimum": 1,
                              "maximum": 10
                            },
                            "max_retries": {
                              "type": "integer",
                              "minimum": 1,
                              "maximum": 10
                            },
                            "http_method": {
                              "type": "string",
                              "enum": [
                                "HEAD",
                                "POST",
                                "CONNECT",
                                "OPTIONS",
                                "PATCH",
                                "PUT",
                                "DELETE",
                                "TRACE",
                                "GET"
                              ]
                            },
                            "url_path": {
                              "type": "string",
                              "format": "url_path"
                            },
                            "expected_codes": {
                              "type": "string"
                            },
                            "admin_state_up": {
                              "type": "boolean"
                            },
                            "tags": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "maxLength": 255
                              }
                            },
                            "http_version": {
                              "type": "number",
                              "enum": [
                                1.0,
                                1.1
                              ]
                            },
                            "domain_name": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 255
                            }
                          },
                          "description": "Defines mandatory and optional attributes of a POST request.",
                          "required": [
                            "delay",
                            "timeout",
                            "max_retries",
                            "type"
                          ]
                        },
                        "members": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "maxLength": 255
                              },
                              "admin_state_up": {
                                "type": "boolean"
                              },
                              "address": {
                                "type": "string",
                                "format": "ipaddress"
                              },
                              "protocol_port": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                              },
                              "weight": {
                                "type": "integer",
                                "maximum": 256
                              },
                              "backup": {
                                "type": "boolean"
                              },
                              "subnet_id": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "monitor_port": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                              },
                              "monitor_address": {
                                "type": "string",
                                "format": "ipaddress"
                              },
                              "tags": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "maxLength": 255
                                }
                              }
                            },
                            "description": "Defines mandatory and optional attributes of a POST request.",
                            "required": [
                              "protocol_port",
                              "address"
                            ]
                          }
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "maxLength": 255
                          }
                        },
                        "tls_container_ref": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "ca_tls_container_ref": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "crl_container_ref": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "tls_enabled": {
                          "type": "boolean"
                        },
                        "tls_ciphers": {
                          "type": "string",
                          "maxLength": 2048
                        },
                        "tls_versions": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "maxLength": 32
                          }
                        },
                        "alpn_protocols": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "format": "alpn_protocol"
                          }
                        }
                      },
                      "description": "Defines mandatory and optional attributes of a POST request."
                    },
                    "redirect_url": {
                      "type": "string",
                      "format": "url"
                    },
                    "redirect_prefix": {
                      "type": "string",
                      "format": "url"
                    },
                    "position": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "rules": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "HEADER",
                              "FILE_TYPE",
                              "SSL_CONN_HAS_CERT",
                              "SSL_VERIFY_RESULT",
                              "SSL_DN_FIELD",
                              "HOST_NAME",
                              "COOKIE",
                              "PATH"
                            ]
                          },
                          "compare_type": {
                            "type": "string",
                            "enum": [
                              "EQUAL_TO",
                              "CONTAINS",
                              "REGEX",
                              "ENDS_WITH",
                              "STARTS_WITH"
                            ]
                          },
                          "key": {
                            "type": "string",
                            "maxLength": 255
                          },
                          "value": {
                            "type": "string",
                            "maxLength": 255
                          },
                          "invert": {
                            "type": "boolean"
                          },
                          "admin_state_up": {
                            "type": "boolean"
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "maxLength": 255
                            }
                          }
                        },
                        "description": "Defines mandatory and optional attributes of a POST request.",
                        "required": [
                          "value",
                          "compare_type",
                          "type"
                        ]
                      }
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "maxLength": 255
                      }
                    },
                    "redirect_http_code": {
                      "type": "integer",
                      "enum": [
                        301,
                        302,
                        303,
                        307,
                        308
                      ]
                    }
                  },
                  "description": "Defines mandatory and optional attributes of a POST request.",
                  "required": [
                    "action"
                  ]
                }
              },
              "insert_headers": {
                "type": "object",
                "additionalProperties": {
                  "type": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              },
              "timeout_client_data": {
                "type": "integer",
                "maximum": 2073600000
              },
              "timeout_member_connect": {
                "type": "integer",
                "maximum": 2073600000
              },
              "timeout_member_data": {
                "type": "integer",
                "maximum": 2073600000
              },
              "timeout_tcp_inspect": {
                "type": "integer",
                "maximum": 2073600000
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "client_ca_tls_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "client_authentication": {
                "type": "string",
                "enum": [
                  "OPTIONAL",
                  "MANDATORY",
                  "NONE"
                ]
              },
              "client_crl_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "allowed_cidrs": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "cidr"
                }
              },
              "tls_ciphers": {
                "type": "string",
                "maxLength": 2048
              },
              "tls_versions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 32
                }
              },
              "alpn_protocols": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "alpn_protocol"
                }
              },
              "hsts_max_age": {
                "type": "integer"
              },
              "hsts_include_subdomains": {
                "type": "boolean"
              },
              "hsts_preload": {
                "type": "boolean"
              }
            },
            "description": "Defines mandatory and optional attributes of a POST request.",
            "required": [
              "protocol_port",
              "protocol"
            ]
          },
          "description": "The associated listener IDs, if any."
        },
        "pools": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 255
              },
              "description": {
                "type": "string",
                "maxLength": 255
              },
              "admin_state_up": {
                "type": "boolean"
              },
              "protocol": {
                "type": "string",
                "enum": [
                  "PROXY",
                  "HTTP",
                  "SCTP",
                  "TCP",
                  "UDP",
                  "HTTPS",
                  "PROXYV2"
                ]
              },
              "lb_algorithm": {
                "type": "string",
                "enum": [
                  "ROUND_ROBIN",
                  "LEAST_CONNECTIONS",
                  "SOURCE_IP_PORT",
                  "SOURCE_IP"
                ]
              },
              "session_persistence": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "HTTP_COOKIE",
                      "SOURCE_IP",
                      "APP_COOKIE"
                    ]
                  },
                  "cookie_name": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "persistence_timeout": {
                    "type": "integer"
                  },
                  "persistence_granularity": {
                    "type": "string",
                    "format": "ipaddress"
                  }
                },
                "description": "Defines mandatory and optional attributes of a POST request.",
                "required": [
                  "type"
                ]
              },
              "healthmonitor": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "HTTP",
                      "SCTP",
                      "UDP-CONNECT",
                      "TLS-HELLO",
                      "TCP",
                      "HTTPS",
                      "PING"
                    ]
                  },
                  "delay": {
                    "type": "integer"
                  },
                  "timeout": {
                    "type": "integer"
                  },
                  "max_retries_down": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 10
                  },
                  "max_retries": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 10
                  },
                  "http_method": {
                    "type": "string",
                    "enum": [
                      "HEAD",
                      "POST",
                      "CONNECT",
                      "OPTIONS",
                      "PATCH",
                      "PUT",
                      "DELETE",
                      "TRACE",
                      "GET"
                    ]
                  },
                  "url_path": {
                    "type": "string",
                    "format": "url_path"
                  },
                  "expected_codes": {
                    "type": "string"
                  },
                  "admin_state_up": {
                    "type": "boolean"
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "http_version": {
                    "type": "number",
                    "enum": [
                      1.0,
                      1.1
                    ]
                  },
                  "domain_name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  }
                },
                "description": "Defines mandatory and optional attributes of a POST request.",
                "required": [
                  "delay",
                  "timeout",
                  "max_retries",
                  "type"
                ]
              },
              "members": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "admin_state_up": {
                      "type": "boolean"
                    },
                    "address": {
                      "type": "string",
                      "format": "ipaddress"
                    },
                    "protocol_port": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    },
                    "weight": {
                      "type": "integer",
                      "maximum": 256
                    },
                    "backup": {
                      "type": "boolean"
                    },
                    "subnet_id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "monitor_port": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    },
                    "monitor_address": {
                      "type": "string",
                      "format": "ipaddress"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "maxLength": 255
                      }
                    }
                  },
                  "description": "Defines mandatory and optional attributes of a POST request.",
                  "required": [
                    "protocol_port",
                    "address"
                  ]
                }
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "tls_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "ca_tls_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "crl_container_ref": {
                "type": "string",
                "maxLength": 255
              },
              "tls_enabled": {
                "type": "boolean"
              },
              "tls_ciphers": {
                "type": "string",
                "maxLength": 2048
              },
              "tls_versions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 32
                }
              },
              "alpn_protocols": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "alpn_protocol"
                }
              }
            },
            "description": "Defines mandatory and optional attributes of a POST request."
          }
        },
        "provider": {
          "type": "string",
          "maxLength": 64,
          "description": "Provider name for the load balancer. Default is `octavia`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          }
        },
        "flavor_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the flavor."
        },
        "availability_zone": {
          "type": "string",
          "maxLength": 255,
          "description": "An availability zone name."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "A load balancer object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
loadbalancer	body	object	A load balancer object.
loadbalancer.id	body	string
loadbalancer.name	body	string
loadbalancer.description	body	string
loadbalancer.provisioning_status	body	string
loadbalancer.operating_status	body	string
loadbalancer.admin_state_up	body	boolean
loadbalancer.project_id	body	string
loadbalancer.created_at	body	string
loadbalancer.updated_at	body	string
loadbalancer.vip_address	body	string	The IP address of the Virtual IP (VIP).
loadbalancer.vip_port_id	body	string	The ID of the Virtual IP (VIP) port.
loadbalancer.vip_subnet_id	body	string	The ID of the subnet for the Virtual IP (VIP).
loadbalancer.vip_network_id	body	string	The ID of the network for the Virtual IP (VIP).
loadbalancer.provider	body	string	Provider name for the load balancer.
loadbalancer.flavor_id	body	string	The ID of the flavor.
loadbalancer.vip_qos_policy_id	body	string	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
loadbalancer.availability_zone	body	string	An availability zone name.
loadbalancer.tenant_id	body	string

404¶

Error

GET

/v2/lbaas/loadbalancers/{loadbalancer_id}/stats

Get Load Balancer statistics

Shows the current statistics for a load balancer.

This operation returns the statistics of a load balancer object identified by loadbalancer_id.

If you are not an administrative user and the load balancer object does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
stats	body	object	A statistics object.
stats.bytes_in	body	integer	The total bytes received.
stats.bytes_out	body	integer	The total bytes sent.
stats.active_connections	body	integer	The currently active connections.
stats.total_connections	body	integer	The total connections handled.
stats.request_errors	body	integer	The total requests that were unable to be fulfilled.

404¶

Error

GET

/v2/lbaas/loadbalancers/{loadbalancer_id}/status

Get the Load Balancer status tree

Shows the status tree for a load balancer.

This operation returns a status tree for a load balancer object, by load balancer ID.

provisioning_status is the status associated with lifecycle of the resource. See Provisioning Status Codes for descriptions of the status codes.

operating_status is the observed status of the resource. See Operating Status Codes for descriptions of the status codes.

If you are not an administrative user and the load balancer object does not belong to your project, the service returns the HTTP Forbidden (403) response code.

If the operation succeeds, the returned element is a status tree that contains the load balancer and all provisioning and operating statuses for its children.

Responses¶

200¶

Name	Location	Type	Description
statuses	body	object	The status tree of a load balancer object contains all provisioning and operating statuses for its children.
statuses.loadbalancer	body	object	A load balancer status object.
statuses.loadbalancer.id	body	string	The ID of the resource.
statuses.loadbalancer.name	body	string	Human-readable name of the resource.
statuses.loadbalancer.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
statuses.loadbalancer.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.

404¶

Error

GET

/v2/lbaas/loadbalancers/{loadbalancer_id}/statuses

Responses¶

200¶

Name	Location	Type	Description
statuses	body	object	Base type for complex types
statuses.loadbalancer	body	object	Defines which attributes are to be shown on status response.
statuses.loadbalancer.id	body	string
statuses.loadbalancer.name	body	string
statuses.loadbalancer.operating_status	body	string
statuses.loadbalancer.provisioning_status	body	string

404¶

Error

PUT

/v2/lbaas/loadbalancers/{loadbalancer_id}/failover

Failover a load balancer

Performs a failover of a load balancer.

This operation is only available to users with load balancer administrative rights.

Request¶

Description

Name

Location

Type

Description

loadbalancer_id

path

string

loadbalancer_id parameter for /v2/lbaas/loadbalancers/{loadbalancer_id}/failover API

Schema

{
  "type": "object",
  "description": "Request of the lbaas/loadbalancers/loadbalancer_id/failover:put operation",
  "x-openstack": {
    "action-name": "failover"
  }
}

Responses¶

202¶

404¶

Error

listeners¶

GET

/v2/lbaas/listeners/{listener_id}

Show Listener details

Shows the details of a listener.

If you are not an administrative user and the parent load balancer does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
listener	body	object	A listener object.
listener.id	body	string	The ID of the listener.
listener.name	body	string	Human-readable name of the resource.
listener.description	body	string	A human-readable description for the resource.
listener.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
listener.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
listener.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
listener.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `SCTP`, `PROMETHEUS`, `TCP`, `TERMINATED_HTTPS`, or `UDP`.
listener.protocol_port	body	integer	The protocol port number for the resource.
listener.connection_limit	body	integer	The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections or a default value defined by the provider driver.
listener.default_tls_container_ref	body	string	The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for `TERMINATED_HTTPS` listeners.
listener.project_id	body	string	The ID of the project owning this resource.
listener.default_pool_id	body	string	The ID of the pool used by the listener if no L7 policies match. The pool has some restrictions. See Protocol Combinations (Listener/Pool).
listener.insert_headers	body	object	A dictionary of optional headers to insert into the request before it is sent to the backend `member`. See Supported HTTP Header Insertions. Both keys and values are always specified as strings.
listener.created_at	body	string	The UTC date and timestamp when the resource was created.
listener.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
listener.timeout_client_data	body	integer	Frontend client inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_member_connect	body	integer	Backend member connection timeout in milliseconds. Default: 5000. New in version 2.1
listener.timeout_member_data	body	integer	Backend member inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_tcp_inspect	body	integer	Time, in milliseconds, to wait for additional TCP packets for content inspection. Default: 0. New in version 2.1
listener.client_ca_tls_container_ref	body	string	The ref of the key manager service secret containing a PEM format client CA certificate bundle for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.client_authentication	body	string	The TLS client authentication mode. One of the options `NONE`, `OPTIONAL` or `MANDATORY`. New in version 2.8
listener.client_crl_container_ref	body	string	The URI of the key manager service secret containing a PEM format CA revocation list file for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
listener.hsts_max_age	body	integer	The value of the `max_age` directive for the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_include_subdomains	body	boolean	Defines whether the `includeSubDomains` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_preload	body	boolean	Defines whether the `preload` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/listeners/{listener_id}

Update a Listener

Update an existing listener.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the listener provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the listener object for changes.

This operation returns the updated listener object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
listener_id	path	string	listener_id parameter for /v2/lbaas/listeners/{listener_id}/stats API
listener	body	object	Defines attributes that are acceptable of a PUT request.
listener.name	body	string	Human-readable name of the resource.
listener.description	body	string	A human-readable description for the resource.
listener.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
listener.connection_limit	body	integer	The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections or a default value defined by the provider driver.
listener.default_tls_container_ref	body	string	The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for `TERMINATED_HTTPS` listeners.
listener.default_pool_id	body	string	The ID of the pool used by the listener if no L7 policies match. The pool has some restrictions. See Protocol Combinations (Listener/Pool).
listener.insert_headers	body	object	A dictionary of optional headers to insert into the request before it is sent to the backend `member`. See Supported HTTP Header Insertions. Both keys and values are always specified as strings.
listener.timeout_client_data	body	integer	Frontend client inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_member_connect	body	integer	Backend member connection timeout in milliseconds. Default: 5000. New in version 2.1
listener.timeout_member_data	body	integer	Backend member inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_tcp_inspect	body	integer	Time, in milliseconds, to wait for additional TCP packets for content inspection. Default: 0. New in version 2.1
listener.client_ca_tls_container_ref	body	string	The ref of the key manager service secret containing a PEM format client CA certificate bundle for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.client_authentication	body	string	The TLS client authentication mode. One of the options `NONE`, `OPTIONAL` or `MANDATORY`. New in version 2.8
listener.client_crl_container_ref	body	string	The URI of the key manager service secret containing a PEM format CA revocation list file for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
listener.hsts_max_age	body	integer	The value of the `max_age` directive for the Strict-Transport-Security HTTP response header. Setting this enables HTTP Strict Transport Security (HSTS) for the TLS-terminated listener. New in version 2.27
listener.hsts_include_subdomains	body	boolean	Defines whether the `includeSubDomains` directive should be added to the Strict-Transport-Security HTTP response header. This requires setting the `hsts_max_age` option as well in order to become effective. New in version 2.27
listener.hsts_preload	body	boolean	Defines whether the `preload` directive should be added to the Strict-Transport-Security HTTP response header. This requires setting the `hsts_max_age` option as well in order to become effective. New in version 2.27

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "listener": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "connection_limit": {
          "type": "integer",
          "minimum": -1,
          "description": "The maximum number of connections permitted for this listener. Default\nvalue is -1 which represents infinite connections or a default value\ndefined by the provider driver."
        },
        "default_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The URI of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners.\nDEPRECATED: A secret container of type \u201ccertificate\u201d containing the\ncertificate and key for `TERMINATED_HTTPS` listeners."
        },
        "sni_container_refs": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of URIs to the [key manager service](https://docs.openstack.org/barbican/latest/) secrets containing\nPKCS12 format certificate/key bundles for `TERMINATED_HTTPS` listeners.\n(DEPRECATED) Secret containers of type \u201ccertificate\u201d containing the\ncertificates and keys for `TERMINATED_HTTPS` listeners."
        },
        "default_pool_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the pool used by the listener if no L7 policies match. The pool\nhas some restrictions. See [Protocol Combinations (Listener/Pool)](#valid-protocol)."
        },
        "insert_headers": {
          "type": "object",
          "additionalProperties": {
            "type": {
              "type": "string",
              "maxLength": 255
            }
          },
          "description": "A dictionary of optional headers to insert into the request before it is\nsent to the backend `member`. See [Supported HTTP Header Insertions](#header-insertions). Both keys\nand values are always specified as strings."
        },
        "timeout_client_data": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Frontend client inactivity timeout in milliseconds. Default: 50000.\n\n\n**New in version 2.1**"
        },
        "timeout_member_connect": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Backend member connection timeout in milliseconds. Default: 5000.\n\n\n**New in version 2.1**"
        },
        "timeout_member_data": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Backend member inactivity timeout in milliseconds. Default: 50000.\n\n\n**New in version 2.1**"
        },
        "timeout_tcp_inspect": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Time, in milliseconds, to wait for additional TCP packets for content\ninspection. Default: 0.\n\n\n**New in version 2.1**"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "client_ca_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The ref of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format client CA certificate bundle for `TERMINATED_HTTPS`\nlisteners.\n\n\n**New in version 2.8**"
        },
        "client_authentication": {
          "type": "string",
          "enum": [
            "OPTIONAL",
            "MANDATORY",
            "NONE"
          ],
          "description": "The TLS client authentication mode. One of the options `NONE`,\n`OPTIONAL` or `MANDATORY`.\n\n\n**New in version 2.8**"
        },
        "client_crl_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The URI of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA revocation list file for `TERMINATED_HTTPS` listeners.\n\n\n**New in version 2.8**"
        },
        "allowed_cidrs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "cidr"
          },
          "description": "A list of IPv4, IPv6 or mix of both CIDRs. The default is all allowed.\nWhen a list of CIDRs is provided, the default switches to deny all.\n\n\n**New in version 2.12**"
        },
        "tls_ciphers": {
          "type": "string",
          "maxLength": 2048,
          "description": "List of ciphers in OpenSSL format (colon-separated).\nSee <https://www.openssl.org/docs/man1.1.1/man1/ciphers.html>\n\n\n**New in version 2.15**"
        },
        "tls_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32
          },
          "description": "A list of TLS protocol versions.\nAvailable versions: SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n\n\n**New in version 2.17**"
        },
        "alpn_protocols": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "alpn_protocol"
          },
          "description": "A list of ALPN protocols.\nAvailable protocols: http/1.0, http/1.1, h2\n\n\n**New in version 2.20**"
        },
        "hsts_max_age": {
          "type": "integer",
          "description": "The value of the `max_age` directive for the\nStrict-Transport-Security HTTP response header.\nSetting this enables HTTP Strict Transport\nSecurity (HSTS) for the TLS-terminated listener.\n\n\n**New in version 2.27**"
        },
        "hsts_include_subdomains": {
          "type": "boolean",
          "description": "Defines whether the `includeSubDomains` directive should be\nadded to the Strict-Transport-Security HTTP response\nheader. This requires setting the `hsts_max_age` option as well in\norder to become effective.\n\n\n**New in version 2.27**"
        },
        "hsts_preload": {
          "type": "boolean",
          "description": "Defines whether the `preload` directive should be\nadded to the Strict-Transport-Security HTTP response\nheader. This requires setting the `hsts_max_age` option as well in\norder to become effective.\n\n\n**New in version 2.27**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
listener	body	object	A listener object.
listener.id	body	string	The ID of the listener.
listener.name	body	string	Human-readable name of the resource.
listener.description	body	string	A human-readable description for the resource.
listener.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
listener.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
listener.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
listener.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `SCTP`, `PROMETHEUS`, `TCP`, `TERMINATED_HTTPS`, or `UDP`.
listener.protocol_port	body	integer	The protocol port number for the resource.
listener.connection_limit	body	integer	The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections or a default value defined by the provider driver.
listener.default_tls_container_ref	body	string	The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for `TERMINATED_HTTPS` listeners.
listener.project_id	body	string	The ID of the project owning this resource.
listener.default_pool_id	body	string	The ID of the pool used by the listener if no L7 policies match. The pool has some restrictions. See Protocol Combinations (Listener/Pool).
listener.insert_headers	body	object	A dictionary of optional headers to insert into the request before it is sent to the backend `member`. See Supported HTTP Header Insertions. Both keys and values are always specified as strings.
listener.created_at	body	string	The UTC date and timestamp when the resource was created.
listener.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
listener.timeout_client_data	body	integer	Frontend client inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_member_connect	body	integer	Backend member connection timeout in milliseconds. Default: 5000. New in version 2.1
listener.timeout_member_data	body	integer	Backend member inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_tcp_inspect	body	integer	Time, in milliseconds, to wait for additional TCP packets for content inspection. Default: 0. New in version 2.1
listener.client_ca_tls_container_ref	body	string	The ref of the key manager service secret containing a PEM format client CA certificate bundle for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.client_authentication	body	string	The TLS client authentication mode. One of the options `NONE`, `OPTIONAL` or `MANDATORY`. New in version 2.8
listener.client_crl_container_ref	body	string	The URI of the key manager service secret containing a PEM format CA revocation list file for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
listener.hsts_max_age	body	integer	The value of the `max_age` directive for the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_include_subdomains	body	boolean	Defines whether the `includeSubDomains` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_preload	body	boolean	Defines whether the `preload` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/listeners/{listener_id}

Remove a Listener

Removes a listener and its associated configuration from the project.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/listeners

List Listeners

Lists all listeners for the project.

Administrative users can specify a project ID that is different than their own to list listeners for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/listeners

Create Listener

Creates a listener for a load balancer.

The listener configures a port and protocol for the load balancer to listen on for incoming requests. A load balancer may have zero or more listeners configured.

This operation provisions a new listener by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object that contains a unique ID and the status of provisioning the listener.

In the response, the listener provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/listeners/{listener_id} to view the progress of the provisioning operation. When the listener status changes to ACTIVE, the listener is successfully provisioned and is ready for further configuration.

Specifying a project_id is deprecated. The listener will inherit the project_id of the parent load balancer.

You can configure all documented features of the listener at creation time by specifying the additional elements or attributes in the request.

To create a listener, the parent load balancer must have an ACTIVE provisioning status.

Request¶

Description

Name	Location	Type	Description
listener	body	object	Defines mandatory and optional attributes of a POST request.
listener.name	body	string	Human-readable name of the resource.
listener.description	body	string	A human-readable description for the resource.
listener.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
listener.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `SCTP`, `PROMETHEUS`, `TCP`, `TERMINATED_HTTPS`, or `UDP`.
listener.protocol_port	body	integer	The protocol port number for the resource.
listener.connection_limit	body	integer	The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections or a default value defined by the provider driver.
listener.default_tls_container_ref	body	string	The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for `TERMINATED_HTTPS` listeners.
listener.project_id	body	string	The ID of the project owning this resource. (deprecated)
listener.default_pool_id	body	string	The ID of the pool used by the listener if no L7 policies match. The pool has some restrictions. See Protocol Combinations (Listener/Pool).
listener.default_pool	body	object	A pool object.
listener.default_pool.name	body	string
listener.default_pool.description	body	string
listener.default_pool.admin_state_up	body	boolean
listener.default_pool.protocol	body	string
listener.default_pool.lb_algorithm	body	string
listener.default_pool.session_persistence	body	object	Defines mandatory and optional attributes of a POST request.
listener.default_pool.session_persistence.type	body	string
listener.default_pool.session_persistence.cookie_name	body	string
listener.default_pool.session_persistence.persistence_timeout	body	integer
listener.default_pool.session_persistence.persistence_granularity	body	string
listener.default_pool.healthmonitor	body	object	Defines mandatory and optional attributes of a POST request.
listener.default_pool.healthmonitor.name	body	string
listener.default_pool.healthmonitor.type	body	string
listener.default_pool.healthmonitor.delay	body	integer
listener.default_pool.healthmonitor.timeout	body	integer
listener.default_pool.healthmonitor.max_retries_down	body	integer
listener.default_pool.healthmonitor.max_retries	body	integer
listener.default_pool.healthmonitor.http_method	body	string
listener.default_pool.healthmonitor.url_path	body	string
listener.default_pool.healthmonitor.expected_codes	body	string
listener.default_pool.healthmonitor.admin_state_up	body	boolean
listener.default_pool.healthmonitor.http_version	body	number
listener.default_pool.healthmonitor.domain_name	body	string
listener.default_pool.tls_container_ref	body	string
listener.default_pool.ca_tls_container_ref	body	string
listener.default_pool.crl_container_ref	body	string
listener.default_pool.tls_enabled	body	boolean
listener.default_pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
listener.insert_headers	body	object	A dictionary of optional headers to insert into the request before it is sent to the backend `member`. See Supported HTTP Header Insertions. Both keys and values are always specified as strings.
listener.loadbalancer_id	body	string	The ID of the load balancer.
listener.timeout_client_data	body	integer	Frontend client inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_member_connect	body	integer	Backend member connection timeout in milliseconds. Default: 5000. New in version 2.1
listener.timeout_member_data	body	integer	Backend member inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_tcp_inspect	body	integer	Time, in milliseconds, to wait for additional TCP packets for content inspection. Default: 0. New in version 2.1
listener.client_ca_tls_container_ref	body	string	The ref of the key manager service secret containing a PEM format client CA certificate bundle for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.client_authentication	body	string	The TLS client authentication mode. One of the options `NONE`, `OPTIONAL` or `MANDATORY`. New in version 2.8
listener.client_crl_container_ref	body	string	The URI of the key manager service secret containing a PEM format CA revocation list file for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.tls_ciphers	body	string
listener.hsts_max_age	body	integer	The value of the `max_age` directive for the Strict-Transport-Security HTTP response header. Setting this enables HTTP Strict Transport Security (HSTS) for the TLS-terminated listener. New in version 2.27
listener.hsts_include_subdomains	body	boolean	Defines whether the `includeSubDomains` directive should be added to the Strict-Transport-Security HTTP response header. This requires setting the `hsts_max_age` option as well in order to become effective. New in version 2.27
listener.hsts_preload	body	boolean	Defines whether the `preload` directive should be added to the Strict-Transport-Security HTTP response header. This requires setting the `hsts_max_age` option as well in order to become effective. New in version 2.27
listener.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "listener": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "protocol": {
          "type": "string",
          "enum": [
            "HTTP",
            "SCTP",
            "TERMINATED_HTTPS",
            "TCP",
            "UDP",
            "HTTPS",
            "PROMETHEUS"
          ],
          "description": "The protocol for the resource. One of `HTTP`, `HTTPS`, `SCTP`,\n`PROMETHEUS`, `TCP`, `TERMINATED_HTTPS`, or `UDP`."
        },
        "protocol_port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "description": "The protocol port number for the resource."
        },
        "connection_limit": {
          "type": "integer",
          "minimum": -1,
          "description": "The maximum number of connections permitted for this listener. Default\nvalue is -1 which represents infinite connections or a default value\ndefined by the provider driver."
        },
        "default_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The URI of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners.\nDEPRECATED: A secret container of type \u201ccertificate\u201d containing the\ncertificate and key for `TERMINATED_HTTPS` listeners."
        },
        "sni_container_refs": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of URIs to the [key manager service](https://docs.openstack.org/barbican/latest/) secrets containing\nPKCS12 format certificate/key bundles for `TERMINATED_HTTPS` listeners.\n(DEPRECATED) Secret containers of type \u201ccertificate\u201d containing the\ncertificates and keys for `TERMINATED_HTTPS` listeners."
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource. (deprecated)"
        },
        "default_pool_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the pool used by the listener if no L7 policies match. The pool\nhas some restrictions. See [Protocol Combinations (Listener/Pool)](#valid-protocol)."
        },
        "default_pool": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 255
            },
            "description": {
              "type": "string",
              "maxLength": 255
            },
            "admin_state_up": {
              "type": "boolean"
            },
            "protocol": {
              "type": "string",
              "enum": [
                "PROXY",
                "HTTP",
                "SCTP",
                "TCP",
                "UDP",
                "HTTPS",
                "PROXYV2"
              ]
            },
            "lb_algorithm": {
              "type": "string",
              "enum": [
                "ROUND_ROBIN",
                "LEAST_CONNECTIONS",
                "SOURCE_IP_PORT",
                "SOURCE_IP"
              ]
            },
            "session_persistence": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "HTTP_COOKIE",
                    "SOURCE_IP",
                    "APP_COOKIE"
                  ]
                },
                "cookie_name": {
                  "type": "string",
                  "maxLength": 255
                },
                "persistence_timeout": {
                  "type": "integer"
                },
                "persistence_granularity": {
                  "type": "string",
                  "format": "ipaddress"
                }
              },
              "description": "Defines mandatory and optional attributes of a POST request.",
              "required": [
                "type"
              ]
            },
            "healthmonitor": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 255
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "HTTP",
                    "SCTP",
                    "UDP-CONNECT",
                    "TLS-HELLO",
                    "TCP",
                    "HTTPS",
                    "PING"
                  ]
                },
                "delay": {
                  "type": "integer"
                },
                "timeout": {
                  "type": "integer"
                },
                "max_retries_down": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 10
                },
                "max_retries": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 10
                },
                "http_method": {
                  "type": "string",
                  "enum": [
                    "HEAD",
                    "POST",
                    "CONNECT",
                    "OPTIONS",
                    "PATCH",
                    "PUT",
                    "DELETE",
                    "TRACE",
                    "GET"
                  ]
                },
                "url_path": {
                  "type": "string",
                  "format": "url_path"
                },
                "expected_codes": {
                  "type": "string"
                },
                "admin_state_up": {
                  "type": "boolean"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
                },
                "http_version": {
                  "type": "number",
                  "enum": [
                    1.0,
                    1.1
                  ]
                },
                "domain_name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                }
              },
              "description": "Defines mandatory and optional attributes of a POST request.",
              "required": [
                "delay",
                "timeout",
                "max_retries",
                "type"
              ]
            },
            "members": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "admin_state_up": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "string",
                    "format": "ipaddress"
                  },
                  "protocol_port": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  },
                  "weight": {
                    "type": "integer",
                    "maximum": 256
                  },
                  "backup": {
                    "type": "boolean"
                  },
                  "subnet_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "monitor_port": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  },
                  "monitor_address": {
                    "type": "string",
                    "format": "ipaddress"
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 255
                    }
                  }
                },
                "description": "Defines mandatory and optional attributes of a POST request.",
                "required": [
                  "protocol_port",
                  "address"
                ]
              }
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 255
              }
            },
            "tls_container_ref": {
              "type": "string",
              "maxLength": 255
            },
            "ca_tls_container_ref": {
              "type": "string",
              "maxLength": 255
            },
            "crl_container_ref": {
              "type": "string",
              "maxLength": 255
            },
            "tls_enabled": {
              "type": "boolean"
            },
            "tls_ciphers": {
              "type": "string",
              "maxLength": 2048,
              "description": "List of ciphers in OpenSSL format (colon-separated).\nSee <https://www.openssl.org/docs/man1.1.1/man1/ciphers.html>\n\n\n**New in version 2.15**"
            },
            "tls_versions": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 32
              },
              "description": "A list of TLS protocol versions.\nAvailable versions: SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n\n\n**New in version 2.17**"
            },
            "alpn_protocols": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "alpn_protocol"
              },
              "description": "A list of ALPN protocols.\nAvailable protocols: http/1.0, http/1.1, h2\n\n\n**New in version 2.20**"
            }
          },
          "description": "A pool object."
        },
        "l7policies": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 255
              },
              "description": {
                "type": "string",
                "maxLength": 255
              },
              "admin_state_up": {
                "type": "boolean"
              },
              "action": {
                "type": "string",
                "enum": [
                  "REDIRECT_TO_URL",
                  "REDIRECT_PREFIX",
                  "REJECT",
                  "REDIRECT_TO_POOL"
                ]
              },
              "redirect_pool": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "admin_state_up": {
                    "type": "boolean"
                  },
                  "protocol": {
                    "type": "string",
                    "enum": [
                      "PROXY",
                      "HTTP",
                      "SCTP",
                      "TCP",
                      "UDP",
                      "HTTPS",
                      "PROXYV2"
                    ]
                  },
                  "lb_algorithm": {
                    "type": "string",
                    "enum": [
                      "ROUND_ROBIN",
                      "LEAST_CONNECTIONS",
                      "SOURCE_IP_PORT",
                      "SOURCE_IP"
                    ]
                  },
                  "session_persistence": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "HTTP_COOKIE",
                          "SOURCE_IP",
                          "APP_COOKIE"
                        ]
                      },
                      "cookie_name": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "persistence_timeout": {
                        "type": "integer"
                      },
                      "persistence_granularity": {
                        "type": "string",
                        "format": "ipaddress"
                      }
                    },
                    "description": "Defines mandatory and optional attributes of a POST request.",
                    "required": [
                      "type"
                    ]
                  },
                  "healthmonitor": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "HTTP",
                          "SCTP",
                          "UDP-CONNECT",
                          "TLS-HELLO",
                          "TCP",
                          "HTTPS",
                          "PING"
                        ]
                      },
                      "delay": {
                        "type": "integer"
                      },
                      "timeout": {
                        "type": "integer"
                      },
                      "max_retries_down": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 10
                      },
                      "max_retries": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 10
                      },
                      "http_method": {
                        "type": "string",
                        "enum": [
                          "HEAD",
                          "POST",
                          "CONNECT",
                          "OPTIONS",
                          "PATCH",
                          "PUT",
                          "DELETE",
                          "TRACE",
                          "GET"
                        ]
                      },
                      "url_path": {
                        "type": "string",
                        "format": "url_path"
                      },
                      "expected_codes": {
                        "type": "string"
                      },
                      "admin_state_up": {
                        "type": "boolean"
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "maxLength": 255
                        }
                      },
                      "http_version": {
                        "type": "number",
                        "enum": [
                          1.0,
                          1.1
                        ]
                      },
                      "domain_name": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    },
                    "description": "Defines mandatory and optional attributes of a POST request.",
                    "required": [
                      "delay",
                      "timeout",
                      "max_retries",
                      "type"
                    ]
                  },
                  "members": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "maxLength": 255
                        },
                        "admin_state_up": {
                          "type": "boolean"
                        },
                        "address": {
                          "type": "string",
                          "format": "ipaddress"
                        },
                        "protocol_port": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 65535
                        },
                        "weight": {
                          "type": "integer",
                          "maximum": 256
                        },
                        "backup": {
                          "type": "boolean"
                        },
                        "subnet_id": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "monitor_port": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 65535
                        },
                        "monitor_address": {
                          "type": "string",
                          "format": "ipaddress"
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "maxLength": 255
                          }
                        }
                      },
                      "description": "Defines mandatory and optional attributes of a POST request.",
                      "required": [
                        "protocol_port",
                        "address"
                      ]
                    }
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "tls_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "ca_tls_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "crl_container_ref": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "tls_enabled": {
                    "type": "boolean"
                  },
                  "tls_ciphers": {
                    "type": "string",
                    "maxLength": 2048
                  },
                  "tls_versions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 32
                    }
                  },
                  "alpn_protocols": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "alpn_protocol"
                    }
                  }
                },
                "description": "Defines mandatory and optional attributes of a POST request."
              },
              "redirect_url": {
                "type": "string",
                "format": "url"
              },
              "redirect_prefix": {
                "type": "string",
                "format": "url"
              },
              "position": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "rules": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "HEADER",
                        "FILE_TYPE",
                        "SSL_CONN_HAS_CERT",
                        "SSL_VERIFY_RESULT",
                        "SSL_DN_FIELD",
                        "HOST_NAME",
                        "COOKIE",
                        "PATH"
                      ]
                    },
                    "compare_type": {
                      "type": "string",
                      "enum": [
                        "EQUAL_TO",
                        "CONTAINS",
                        "REGEX",
                        "ENDS_WITH",
                        "STARTS_WITH"
                      ]
                    },
                    "key": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "value": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "invert": {
                      "type": "boolean"
                    },
                    "admin_state_up": {
                      "type": "boolean"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "maxLength": 255
                      }
                    }
                  },
                  "description": "Defines mandatory and optional attributes of a POST request.",
                  "required": [
                    "value",
                    "compare_type",
                    "type"
                  ]
                }
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "redirect_http_code": {
                "type": "integer",
                "enum": [
                  301,
                  302,
                  303,
                  307,
                  308
                ]
              }
            },
            "description": "Defines mandatory and optional attributes of a POST request.",
            "required": [
              "action"
            ]
          },
          "description": "A list of L7 policy objects."
        },
        "insert_headers": {
          "type": "object",
          "additionalProperties": {
            "type": {
              "type": "string",
              "maxLength": 255
            }
          },
          "description": "A dictionary of optional headers to insert into the request before it is\nsent to the backend `member`. See [Supported HTTP Header Insertions](#header-insertions). Both keys\nand values are always specified as strings."
        },
        "loadbalancer_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the load balancer."
        },
        "timeout_client_data": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Frontend client inactivity timeout in milliseconds. Default: 50000.\n\n\n**New in version 2.1**"
        },
        "timeout_member_connect": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Backend member connection timeout in milliseconds. Default: 5000.\n\n\n**New in version 2.1**"
        },
        "timeout_member_data": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Backend member inactivity timeout in milliseconds. Default: 50000.\n\n\n**New in version 2.1**"
        },
        "timeout_tcp_inspect": {
          "type": "integer",
          "maximum": 2073600000,
          "description": "Time, in milliseconds, to wait for additional TCP packets for content\ninspection. Default: 0.\n\n\n**New in version 2.1**"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          }
        },
        "client_ca_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The ref of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format client CA certificate bundle for `TERMINATED_HTTPS`\nlisteners.\n\n\n**New in version 2.8**"
        },
        "client_authentication": {
          "type": "string",
          "enum": [
            "OPTIONAL",
            "MANDATORY",
            "NONE"
          ],
          "description": "The TLS client authentication mode. One of the options `NONE`,\n`OPTIONAL` or `MANDATORY`.\n\n\n**New in version 2.8**"
        },
        "client_crl_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The URI of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA revocation list file for `TERMINATED_HTTPS` listeners.\n\n\n**New in version 2.8**"
        },
        "allowed_cidrs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "cidr"
          },
          "description": "A list of IPv4, IPv6 or mix of both CIDRs. The default is all allowed.\nWhen a list of CIDRs is provided, the default switches to deny all.\n\n\n**New in version 2.12**"
        },
        "tls_ciphers": {
          "type": "string",
          "maxLength": 2048
        },
        "tls_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32
          }
        },
        "alpn_protocols": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "alpn_protocol"
          }
        },
        "hsts_max_age": {
          "type": "integer",
          "description": "The value of the `max_age` directive for the\nStrict-Transport-Security HTTP response header.\nSetting this enables HTTP Strict Transport\nSecurity (HSTS) for the TLS-terminated listener.\n\n\n**New in version 2.27**"
        },
        "hsts_include_subdomains": {
          "type": "boolean",
          "description": "Defines whether the `includeSubDomains` directive should be\nadded to the Strict-Transport-Security HTTP response\nheader. This requires setting the `hsts_max_age` option as well in\norder to become effective.\n\n\n**New in version 2.27**"
        },
        "hsts_preload": {
          "type": "boolean",
          "description": "Defines whether the `preload` directive should be\nadded to the Strict-Transport-Security HTTP response\nheader. This requires setting the `hsts_max_age` option as well in\norder to become effective.\n\n\n**New in version 2.27**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "protocol_port",
        "protocol",
        "loadbalancer_id"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
listener	body	object	A listener object.
listener.id	body	string	The ID of the listener.
listener.name	body	string	Human-readable name of the resource.
listener.description	body	string	A human-readable description for the resource.
listener.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
listener.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
listener.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
listener.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `SCTP`, `PROMETHEUS`, `TCP`, `TERMINATED_HTTPS`, or `UDP`.
listener.protocol_port	body	integer	The protocol port number for the resource.
listener.connection_limit	body	integer	The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections or a default value defined by the provider driver.
listener.default_tls_container_ref	body	string	The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for `TERMINATED_HTTPS` listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for `TERMINATED_HTTPS` listeners.
listener.project_id	body	string	The ID of the project owning this resource.
listener.default_pool_id	body	string	The ID of the pool used by the listener if no L7 policies match. The pool has some restrictions. See Protocol Combinations (Listener/Pool).
listener.insert_headers	body	object	A dictionary of optional headers to insert into the request before it is sent to the backend `member`. See Supported HTTP Header Insertions. Both keys and values are always specified as strings.
listener.created_at	body	string	The UTC date and timestamp when the resource was created.
listener.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
listener.timeout_client_data	body	integer	Frontend client inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_member_connect	body	integer	Backend member connection timeout in milliseconds. Default: 5000. New in version 2.1
listener.timeout_member_data	body	integer	Backend member inactivity timeout in milliseconds. Default: 50000. New in version 2.1
listener.timeout_tcp_inspect	body	integer	Time, in milliseconds, to wait for additional TCP packets for content inspection. Default: 0. New in version 2.1
listener.client_ca_tls_container_ref	body	string	The ref of the key manager service secret containing a PEM format client CA certificate bundle for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.client_authentication	body	string	The TLS client authentication mode. One of the options `NONE`, `OPTIONAL` or `MANDATORY`. New in version 2.8
listener.client_crl_container_ref	body	string	The URI of the key manager service secret containing a PEM format CA revocation list file for `TERMINATED_HTTPS` listeners. New in version 2.8
listener.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
listener.hsts_max_age	body	integer	The value of the `max_age` directive for the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_include_subdomains	body	boolean	Defines whether the `includeSubDomains` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.hsts_preload	body	boolean	Defines whether the `preload` directive should be added to the Strict-Transport-Security HTTP response header. New in version 2.27
listener.tenant_id	body	string

404¶

Error

GET

/v2/lbaas/listeners/{listener_id}/stats

Get Listener statistics

Shows the current statistics for a listener.

This operation returns the statistics of a listener object identified by listener_id.

If you are not an administrative user and the parent load balancer does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
stats	body	object	A statistics object.
stats.bytes_in	body	integer	The total bytes received.
stats.bytes_out	body	integer	The total bytes sent.
stats.active_connections	body	integer	The currently active connections.
stats.total_connections	body	integer	The total connections handled.
stats.request_errors	body	integer	The total requests that were unable to be fulfilled.

404¶

Error

pools¶

GET

/v2/lbaas/pools/{pool_id}

Show Pool details

Shows the details of a pool.

If you are not an administrative user and the parent load balancer does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
pool	body	object	Defines which attributes are to be shown on any response.
pool.id	body	string	The ID of the pool.
pool.name	body	string	Human-readable name of the resource.
pool.description	body	string	A human-readable description for the resource.
pool.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
pool.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
pool.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
pool.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `PROXY`, `PROXYV2`, `SCTP`, `TCP`, or `UDP`.
pool.lb_algorithm	body	string	The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`, `ROUND_ROBIN`, `SOURCE_IP`, or `SOURCE_IP_PORT`.
pool.session_persistence	body	object	A JSON object specifying the session persistence for the pool or `null` for no session persistence. See Pool Session Persistence. Default is `null`.
pool.session_persistence.type	body	string
pool.session_persistence.cookie_name	body	string
pool.session_persistence.persistence_timeout	body	integer
pool.session_persistence.persistence_granularity	body	string
pool.project_id	body	string	The ID of the project owning this resource.
pool.created_at	body	string	The UTC date and timestamp when the resource was created.
pool.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
pool.healthmonitor_id	body	string	The associated health monitor ID.
pool.tls_container_ref	body	string	The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for `tls_enabled` pools for TLS client authentication to the member servers. New in version 2.8
pool.ca_tls_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA certificate bundle for `tls_enabled` pools. New in version 2.8
pool.crl_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA revocation list file for `tls_enabled` pools.
pool.tls_enabled	body	boolean	When `true` connections to backend member servers will use TLS encryption. Default is `false`. New in version 2.8
pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
pool.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/pools/{pool_id}

Update a Pool

Update an existing pool.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the pool provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the pool object for changes.

This operation returns the updated pool object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
pool_id	path	string	pool_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API
pool	body	object	Defines attributes that are acceptable of a PUT request.
pool.name	body	string	Human-readable name of the resource.
pool.description	body	string	A human-readable description for the resource.
pool.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
pool.lb_algorithm	body	string	The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`, `ROUND_ROBIN`, or `SOURCE_IP`.
pool.session_persistence	body	object	A JSON object specifying the session persistence for the pool or `null` for no session persistence. See Pool Session Persistence. Default is `null`.
pool.session_persistence.type	body	string
pool.session_persistence.cookie_name	body	string
pool.session_persistence.persistence_timeout	body	integer
pool.session_persistence.persistence_granularity	body	string
pool.tls_container_ref	body	string	The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for `tls_enabled` pools for TLS client authentication to the member servers. New in version 2.8
pool.ca_tls_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA certificate bundle for `tls_enabled` pools. New in version 2.8
pool.crl_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA revocation list file for `tls_enabled` pools.
pool.tls_enabled	body	boolean	When `true` connections to backend member servers will use TLS encryption. Default is `false`. New in version 2.8
pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "pool": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "lb_algorithm": {
          "type": "string",
          "enum": [
            "ROUND_ROBIN",
            "LEAST_CONNECTIONS",
            "SOURCE_IP_PORT",
            "SOURCE_IP"
          ],
          "description": "The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`,\n`ROUND_ROBIN`, or `SOURCE_IP`."
        },
        "session_persistence": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "HTTP_COOKIE",
                "SOURCE_IP",
                "APP_COOKIE"
              ]
            },
            "cookie_name": {
              "type": "string",
              "maxLength": 255
            },
            "persistence_timeout": {
              "type": "integer"
            },
            "persistence_granularity": {
              "type": "string",
              "format": "ipaddress"
            }
          },
          "description": "A JSON object specifying the session persistence for the pool or `null`\nfor no session persistence. See [Pool Session Persistence](#session-persistence). Default is\n`null`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference to the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPKCS12 format certificate/key bundle for `tls_enabled` pools for\nTLS client authentication to the member servers.\n\n\n**New in version 2.8**"
        },
        "ca_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA certificate bundle for `tls_enabled` pools.\n\n\n**New in version 2.8**"
        },
        "crl_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA revocation list file for `tls_enabled` pools."
        },
        "tls_enabled": {
          "type": "boolean",
          "description": "When `true` connections to backend member servers will use TLS\nencryption. Default is `false`.\n\n\n**New in version 2.8**"
        },
        "tls_ciphers": {
          "type": "string",
          "maxLength": 2048,
          "description": "List of ciphers in OpenSSL format (colon-separated).\nSee <https://www.openssl.org/docs/man1.1.1/man1/ciphers.html>\n\n\n**New in version 2.15**"
        },
        "tls_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32
          },
          "description": "A list of TLS protocol versions.\nAvailable versions: SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n\n\n**New in version 2.17**"
        },
        "alpn_protocols": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "alpn_protocol"
          },
          "description": "A list of ALPN protocols.\nAvailable protocols: http/1.0, http/1.1, h2\n\n\n**New in version 2.24**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
pool	body	object	Defines which attributes are to be shown on any response.
pool.id	body	string	The ID of the pool.
pool.name	body	string	Human-readable name of the resource.
pool.description	body	string	A human-readable description for the resource.
pool.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
pool.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
pool.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
pool.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `PROXY`, `PROXYV2`, `SCTP`, `TCP`, or `UDP`.
pool.lb_algorithm	body	string	The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`, `ROUND_ROBIN`, `SOURCE_IP`, or `SOURCE_IP_PORT`.
pool.session_persistence	body	object	A JSON object specifying the session persistence for the pool or `null` for no session persistence. See Pool Session Persistence. Default is `null`.
pool.session_persistence.type	body	string
pool.session_persistence.cookie_name	body	string
pool.session_persistence.persistence_timeout	body	integer
pool.session_persistence.persistence_granularity	body	string
pool.project_id	body	string	The ID of the project owning this resource.
pool.created_at	body	string	The UTC date and timestamp when the resource was created.
pool.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
pool.healthmonitor_id	body	string	The associated health monitor ID.
pool.tls_container_ref	body	string	The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for `tls_enabled` pools for TLS client authentication to the member servers. New in version 2.8
pool.ca_tls_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA certificate bundle for `tls_enabled` pools. New in version 2.8
pool.crl_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA revocation list file for `tls_enabled` pools.
pool.tls_enabled	body	boolean	When `true` connections to backend member servers will use TLS encryption. Default is `false`. New in version 2.8
pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
pool.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/pools/{pool_id}

Remove a Pool

Removes a pool and its associated configuration from the load balancer.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/pools

List Pools

Lists all pools for the project.

Administrative users can specify a project ID that is different than their own to list pools for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/pools

Create Pool

Creates a pool for a load balancer.

The pool defines how requests should be balanced across the backend member servers.

This operation provisions a pool by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object, which contains a unique ID.

In the response, the pool provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/pools/{pool_id} to view the progress of the provisioning operation. When the pool status changes to ACTIVE, the pool is successfully provisioned and is ready for further configuration.

At a minimum, you must specify these pool attributes:

Some attributes receive default values if you omit them from the request:

Specifying a project_id is deprecated. The pool will inherit the project_id of the parent load balancer.

You can configure all documented features of the pool at creation time by specifying the additional elements or attributes in the request.

To create a pool, the parent load balancer must have an ACTIVE provisioning status.

SOURCE_IP_PORT algorithm is available from version 2.13.

Request¶

Description

Name	Location	Type	Description
pool	body	object	Defines mandatory and optional attributes of a POST request.
pool.name	body	string	Human-readable name of the resource.
pool.description	body	string	A human-readable description for the resource.
pool.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
pool.listener_id	body	string	The ID of the listener for the pool. Either `listener_id` or `loadbalancer_id` must be specified. The listener has some restrictions, See Protocol Combinations (Listener/Pool).
pool.loadbalancer_id	body	string	The ID of the load balancer for the pool. Either `listener_id` or `loadbalancer_id` must be specified.
pool.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `PROXY`, `PROXYV2`, `SCTP`, `TCP`, or `UDP`.
pool.lb_algorithm	body	string	The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`, `ROUND_ROBIN`, `SOURCE_IP`, or `SOURCE_IP_PORT`.
pool.session_persistence	body	object	A JSON object specifying the session persistence for the pool or `null` for no session persistence. See Pool Session Persistence. Default is `null`.
pool.session_persistence.type	body	string
pool.session_persistence.cookie_name	body	string
pool.session_persistence.persistence_timeout	body	integer
pool.session_persistence.persistence_granularity	body	string
pool.project_id	body	string	The ID of the project owning this resource. (deprecated)
pool.healthmonitor	body	object	Defines mandatory and optional attributes of a POST request.
pool.healthmonitor.name	body	string
pool.healthmonitor.type	body	string
pool.healthmonitor.delay	body	integer
pool.healthmonitor.timeout	body	integer
pool.healthmonitor.max_retries_down	body	integer
pool.healthmonitor.max_retries	body	integer
pool.healthmonitor.http_method	body	string
pool.healthmonitor.url_path	body	string
pool.healthmonitor.expected_codes	body	string
pool.healthmonitor.admin_state_up	body	boolean
pool.healthmonitor.http_version	body	number
pool.healthmonitor.domain_name	body	string
pool.tls_container_ref	body	string	The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for `tls_enabled` pools for TLS client authentication to the member servers. New in version 2.8
pool.ca_tls_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA certificate bundle for `tls_enabled` pools. New in version 2.8
pool.crl_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA revocation list file for `tls_enabled` pools.
pool.tls_enabled	body	boolean	When `true` connections to backend member servers will use TLS encryption. Default is `false`. New in version 2.8
pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
pool.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "pool": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "listener_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the listener for the pool. Either `listener_id` or\n`loadbalancer_id` must be specified. The listener has some restrictions,\nSee [Protocol Combinations (Listener/Pool)](#valid-protocol)."
        },
        "loadbalancer_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the load balancer for the pool. Either `listener_id` or\n`loadbalancer_id` must be specified."
        },
        "protocol": {
          "type": "string",
          "enum": [
            "PROXY",
            "HTTP",
            "SCTP",
            "TCP",
            "UDP",
            "HTTPS",
            "PROXYV2"
          ],
          "description": "The protocol for the resource. One of `HTTP`, `HTTPS`, `PROXY`,\n`PROXYV2`, `SCTP`, `TCP`, or `UDP`."
        },
        "lb_algorithm": {
          "type": "string",
          "enum": [
            "ROUND_ROBIN",
            "LEAST_CONNECTIONS",
            "SOURCE_IP_PORT",
            "SOURCE_IP"
          ],
          "description": "The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`,\n`ROUND_ROBIN`, `SOURCE_IP`, or `SOURCE_IP_PORT`."
        },
        "session_persistence": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "HTTP_COOKIE",
                "SOURCE_IP",
                "APP_COOKIE"
              ]
            },
            "cookie_name": {
              "type": "string",
              "maxLength": 255
            },
            "persistence_timeout": {
              "type": "integer"
            },
            "persistence_granularity": {
              "type": "string",
              "format": "ipaddress"
            }
          },
          "description": "A JSON object specifying the session persistence for the pool or `null`\nfor no session persistence. See [Pool Session Persistence](#session-persistence). Default is\n`null`.",
          "required": [
            "type"
          ]
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource. (deprecated)"
        },
        "healthmonitor": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 255
            },
            "type": {
              "type": "string",
              "enum": [
                "HTTP",
                "SCTP",
                "UDP-CONNECT",
                "TLS-HELLO",
                "TCP",
                "HTTPS",
                "PING"
              ]
            },
            "delay": {
              "type": "integer"
            },
            "timeout": {
              "type": "integer"
            },
            "max_retries_down": {
              "type": "integer",
              "minimum": 1,
              "maximum": 10
            },
            "max_retries": {
              "type": "integer",
              "minimum": 1,
              "maximum": 10
            },
            "http_method": {
              "type": "string",
              "enum": [
                "HEAD",
                "POST",
                "CONNECT",
                "OPTIONS",
                "PATCH",
                "PUT",
                "DELETE",
                "TRACE",
                "GET"
              ]
            },
            "url_path": {
              "type": "string",
              "format": "url_path"
            },
            "expected_codes": {
              "type": "string"
            },
            "admin_state_up": {
              "type": "boolean"
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 255
              },
              "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
            },
            "http_version": {
              "type": "number",
              "enum": [
                1.0,
                1.1
              ]
            },
            "domain_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            }
          },
          "description": "Defines mandatory and optional attributes of a POST request.",
          "required": [
            "delay",
            "timeout",
            "max_retries",
            "type"
          ]
        },
        "members": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 255
              },
              "admin_state_up": {
                "type": "boolean"
              },
              "address": {
                "type": "string",
                "format": "ipaddress"
              },
              "protocol_port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "weight": {
                "type": "integer",
                "maximum": 256
              },
              "backup": {
                "type": "boolean"
              },
              "subnet_id": {
                "type": "string",
                "format": "uuid"
              },
              "monitor_port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "monitor_address": {
                "type": "string",
                "format": "ipaddress"
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                }
              }
            },
            "description": "Defines mandatory and optional attributes of a POST request.",
            "required": [
              "protocol_port",
              "address"
            ]
          }
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          }
        },
        "tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference to the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPKCS12 format certificate/key bundle for `tls_enabled` pools for\nTLS client authentication to the member servers.\n\n\n**New in version 2.8**"
        },
        "ca_tls_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA certificate bundle for `tls_enabled` pools.\n\n\n**New in version 2.8**"
        },
        "crl_container_ref": {
          "type": "string",
          "maxLength": 255,
          "description": "The reference of the [key manager service](https://docs.openstack.org/castellan/latest/) secret containing a\nPEM format CA revocation list file for `tls_enabled` pools."
        },
        "tls_enabled": {
          "type": "boolean",
          "description": "When `true` connections to backend member servers will use TLS\nencryption. Default is `false`.\n\n\n**New in version 2.8**"
        },
        "tls_ciphers": {
          "type": "string",
          "maxLength": 2048,
          "description": "List of ciphers in OpenSSL format (colon-separated).\nSee <https://www.openssl.org/docs/man1.1.1/man1/ciphers.html>\n\n\n**New in version 2.15**"
        },
        "tls_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32
          },
          "description": "A list of TLS protocol versions.\nAvailable versions: SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n\n\n**New in version 2.17**"
        },
        "alpn_protocols": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "alpn_protocol"
          },
          "description": "A list of ALPN protocols.\nAvailable protocols: http/1.0, http/1.1, h2\n\n\n**New in version 2.24**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "lb_algorithm",
        "protocol"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
pool	body	object	Defines which attributes are to be shown on any response.
pool.id	body	string	The ID of the pool.
pool.name	body	string	Human-readable name of the resource.
pool.description	body	string	A human-readable description for the resource.
pool.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
pool.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
pool.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
pool.protocol	body	string	The protocol for the resource. One of `HTTP`, `HTTPS`, `PROXY`, `PROXYV2`, `SCTP`, `TCP`, or `UDP`.
pool.lb_algorithm	body	string	The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`, `ROUND_ROBIN`, `SOURCE_IP`, or `SOURCE_IP_PORT`.
pool.session_persistence	body	object	A JSON object specifying the session persistence for the pool or `null` for no session persistence. See Pool Session Persistence. Default is `null`.
pool.session_persistence.type	body	string
pool.session_persistence.cookie_name	body	string
pool.session_persistence.persistence_timeout	body	integer
pool.session_persistence.persistence_granularity	body	string
pool.project_id	body	string	The ID of the project owning this resource.
pool.created_at	body	string	The UTC date and timestamp when the resource was created.
pool.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
pool.healthmonitor_id	body	string	The associated health monitor ID.
pool.tls_container_ref	body	string	The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for `tls_enabled` pools for TLS client authentication to the member servers. New in version 2.8
pool.ca_tls_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA certificate bundle for `tls_enabled` pools. New in version 2.8
pool.crl_container_ref	body	string	The reference of the key manager service secret containing a PEM format CA revocation list file for `tls_enabled` pools.
pool.tls_enabled	body	boolean	When `true` connections to backend member servers will use TLS encryption. Default is `false`. New in version 2.8
pool.tls_ciphers	body	string	List of ciphers in OpenSSL format (colon-separated). See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html New in version 2.15
pool.tenant_id	body	string

404¶

Error

l7-policies¶

GET

/v2/lbaas/l7policies/{l7policy_id}

Show L7 Policy details

Shows the details of a L7 policy.

If you are not an administrative user and the L7 policy object does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
l7policy	body	object	Defines which attributes are to be shown on any response.
l7policy.id	body	string	The ID of the L7 policy.
l7policy.name	body	string	Human-readable name of the resource.
l7policy.description	body	string	A human-readable description for the resource.
l7policy.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
l7policy.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
l7policy.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
l7policy.project_id	body	string	The ID of the project owning this resource.
l7policy.action	body	string	The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`, `REDIRECT_TO_URL`, or `REJECT`.
l7policy.listener_id	body	string	The ID of the listener.
l7policy.redirect_pool_id	body	string	Requests matching this policy will be redirected to the pool with this ID. Only valid if `action` is `REDIRECT_TO_POOL`. The pool has some restrictions, See Protocol Combinations (Listener/Pool).
l7policy.redirect_url	body	string	Requests matching this policy will be redirected to this URL. Only valid if `action` is `REDIRECT_TO_URL`.
l7policy.redirect_prefix	body	string	Requests matching this policy will be redirected to this Prefix URL. Only valid if `action` is `REDIRECT_PREFIX`.
l7policy.position	body	integer	The position of this policy on the listener. Positions start at 1.
l7policy.created_at	body	string	The UTC date and timestamp when the resource was created.
l7policy.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
l7policy.redirect_http_code	body	integer	Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if `action` is `REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302, 303, 307, or 308. Default is 302. New in version 2.9
l7policy.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/l7policies/{l7policy_id}

Update a L7 Policy

Updates a L7 policy.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the L7 policy provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the L7 policy object for changes.

This operation returns the updated L7 policy object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

If a policy is updated with a position that matches that of an existing policy, then the updated policy is inserted at the given position.

Request¶

Description

Name	Location	Type	Description
l7policy_id	path	string	l7policy_id parameter for /v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id} API
l7policy	body	object	Defines attributes that are acceptable of a PUT request.
l7policy.name	body	string	Human-readable name of the resource.
l7policy.description	body	string	A human-readable description for the resource.
l7policy.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
l7policy.action	body	string	The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`, `REDIRECT_TO_URL`, or `REJECT`.
l7policy.redirect_pool_id	body	string	Requests matching this policy will be redirected to the pool with this ID. Only valid if `action` is `REDIRECT_TO_POOL`. The pool has some restrictions, See Protocol Combinations (Listener/Pool).
l7policy.redirect_url	body	string	Requests matching this policy will be redirected to this URL. Only valid if `action` is `REDIRECT_TO_URL`.
l7policy.redirect_prefix	body	string	Requests matching this policy will be redirected to this Prefix URL. Only valid if `action` is `REDIRECT_PREFIX`.
l7policy.position	body	integer	The position of this policy on the listener. Positions start at 1.
l7policy.redirect_http_code	body	integer	Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if `action` is `REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302, 303, 307, or 308. Default is 302. New in version 2.9

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "l7policy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "action": {
          "type": "string",
          "enum": [
            "REDIRECT_TO_URL",
            "REDIRECT_PREFIX",
            "REJECT",
            "REDIRECT_TO_POOL"
          ],
          "description": "The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`,\n`REDIRECT_TO_URL`, or `REJECT`."
        },
        "redirect_pool_id": {
          "type": "string",
          "format": "uuid",
          "description": "Requests matching this policy will be redirected to the pool with this ID.\nOnly valid if `action` is `REDIRECT_TO_POOL`. The pool has some\nrestrictions, See [Protocol Combinations (Listener/Pool)](#valid-protocol)."
        },
        "redirect_url": {
          "type": "string",
          "format": "url",
          "description": "Requests matching this policy will be redirected to this URL.\nOnly valid if `action` is `REDIRECT_TO_URL`."
        },
        "redirect_prefix": {
          "type": "string",
          "format": "url",
          "description": "Requests matching this policy will be redirected to this Prefix URL.\nOnly valid if `action` is `REDIRECT_PREFIX`."
        },
        "position": {
          "type": "integer",
          "minimum": 1,
          "maximum": 2147483647,
          "description": "The position of this policy on the listener. Positions start at 1."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "redirect_http_code": {
          "type": "integer",
          "enum": [
            301,
            302,
            303,
            307,
            308
          ],
          "description": "Requests matching this policy will be redirected to the specified URL or\nPrefix URL with the HTTP response code. Valid if `action` is\n`REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302,\n303, 307, or 308. Default is 302.\n\n\n**New in version 2.9**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
l7policy	body	object	Defines which attributes are to be shown on any response.
l7policy.id	body	string	The ID of the L7 policy.
l7policy.name	body	string	Human-readable name of the resource.
l7policy.description	body	string	A human-readable description for the resource.
l7policy.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
l7policy.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
l7policy.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
l7policy.project_id	body	string	The ID of the project owning this resource.
l7policy.action	body	string	The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`, `REDIRECT_TO_URL`, or `REJECT`.
l7policy.listener_id	body	string	The ID of the listener.
l7policy.redirect_pool_id	body	string	Requests matching this policy will be redirected to the pool with this ID. Only valid if `action` is `REDIRECT_TO_POOL`. The pool has some restrictions, See Protocol Combinations (Listener/Pool).
l7policy.redirect_url	body	string	Requests matching this policy will be redirected to this URL. Only valid if `action` is `REDIRECT_TO_URL`.
l7policy.redirect_prefix	body	string	Requests matching this policy will be redirected to this Prefix URL. Only valid if `action` is `REDIRECT_PREFIX`.
l7policy.position	body	integer	The position of this policy on the listener. Positions start at 1.
l7policy.created_at	body	string	The UTC date and timestamp when the resource was created.
l7policy.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
l7policy.redirect_http_code	body	integer	Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if `action` is `REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302, 303, 307, or 308. Default is 302. New in version 2.9
l7policy.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/l7policies/{l7policy_id}

Remove a L7 Policy

Removes a L7 policy and its associated configuration from the project.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/l7policies

List L7 Policies

Lists all L7 policies for the project.

Administrative users can specify a project ID that is different than their own to list L7 policies for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/l7policies

Create an L7 Policy

Creates a L7 policy.

This operation provisions a new L7 policy by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object that contains a unique ID and the status of provisioning the L7 policy.

In the response, the L7 policy provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/l7policies/{l7policy_id} to view the progress of the provisioning operation. When the L7 policy status changes to ACTIVE, the L7 policy is successfully provisioned and is ready for further configuration.

All the rules associated with a given policy are logically ANDead together. A request must match all the policy’s rules to match the policy.

If you need to express a logical OR operation between rules, then do this by creating multiple policies with the same action.

If a new policy is created with a position that matches that of an existing policy, then the new policy is inserted at the given position.

L7 policies with action of REDIRECT_TO_URL will return the default HTTP Found (302) response code with the redirect_url. Also, specify redirect_http_code to configure the needed HTTP response code, such as, 301, 302, 303, 307 and 308.

L7 policies with action of REJECT will return a Forbidden (403) response code to the requester.

Request¶

Description

Name	Location	Type	Description
l7policy	body	object	Defines mandatory and optional attributes of a POST request.
l7policy.name	body	string	Human-readable name of the resource.
l7policy.description	body	string	A human-readable description for the resource.
l7policy.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
l7policy.project_id	body	string	The ID of the project owning this resource.
l7policy.action	body	string	The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`, `REDIRECT_TO_URL`, or `REJECT`.
l7policy.redirect_pool_id	body	string	Requests matching this policy will be redirected to the pool with this ID. Only valid if `action` is `REDIRECT_TO_POOL`. The pool has some restrictions, See Protocol Combinations (Listener/Pool).
l7policy.redirect_url	body	string	Requests matching this policy will be redirected to this URL. Only valid if `action` is `REDIRECT_TO_URL`.
l7policy.redirect_prefix	body	string	Requests matching this policy will be redirected to this Prefix URL. Only valid if `action` is `REDIRECT_PREFIX`.
l7policy.position	body	integer	The position of this policy on the listener. Positions start at 1.
l7policy.listener_id	body	string	The ID of the listener.
l7policy.redirect_http_code	body	integer	Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if `action` is `REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302, 303, 307, or 308. Default is 302. New in version 2.9
l7policy.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "l7policy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource."
        },
        "action": {
          "type": "string",
          "enum": [
            "REDIRECT_TO_URL",
            "REDIRECT_PREFIX",
            "REJECT",
            "REDIRECT_TO_POOL"
          ],
          "description": "The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`,\n`REDIRECT_TO_URL`, or `REJECT`."
        },
        "redirect_pool_id": {
          "type": "string",
          "format": "uuid",
          "description": "Requests matching this policy will be redirected to the pool with this ID.\nOnly valid if `action` is `REDIRECT_TO_POOL`. The pool has some\nrestrictions, See [Protocol Combinations (Listener/Pool)](#valid-protocol)."
        },
        "redirect_url": {
          "type": "string",
          "format": "url",
          "description": "Requests matching this policy will be redirected to this URL.\nOnly valid if `action` is `REDIRECT_TO_URL`."
        },
        "redirect_prefix": {
          "type": "string",
          "format": "url",
          "description": "Requests matching this policy will be redirected to this Prefix URL.\nOnly valid if `action` is `REDIRECT_PREFIX`."
        },
        "position": {
          "type": "integer",
          "minimum": 1,
          "maximum": 2147483647,
          "description": "The position of this policy on the listener. Positions start at 1."
        },
        "listener_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the listener."
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "HEADER",
                  "FILE_TYPE",
                  "SSL_CONN_HAS_CERT",
                  "SSL_VERIFY_RESULT",
                  "SSL_DN_FIELD",
                  "HOST_NAME",
                  "COOKIE",
                  "PATH"
                ]
              },
              "compare_type": {
                "type": "string",
                "enum": [
                  "EQUAL_TO",
                  "CONTAINS",
                  "REGEX",
                  "ENDS_WITH",
                  "STARTS_WITH"
                ]
              },
              "key": {
                "type": "string",
                "maxLength": 255
              },
              "value": {
                "type": "string",
                "maxLength": 255
              },
              "invert": {
                "type": "boolean"
              },
              "admin_state_up": {
                "type": "boolean"
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 255
                },
                "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
              }
            },
            "description": "Defines mandatory and optional attributes of a POST request.",
            "required": [
              "value",
              "compare_type",
              "type"
            ]
          }
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          }
        },
        "redirect_http_code": {
          "type": "integer",
          "enum": [
            301,
            302,
            303,
            307,
            308
          ],
          "description": "Requests matching this policy will be redirected to the specified URL or\nPrefix URL with the HTTP response code. Valid if `action` is\n`REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302,\n303, 307, or 308. Default is 302.\n\n\n**New in version 2.9**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "listener_id",
        "action"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
l7policy	body	object	Defines which attributes are to be shown on any response.
l7policy.id	body	string	The ID of the L7 policy.
l7policy.name	body	string	Human-readable name of the resource.
l7policy.description	body	string	A human-readable description for the resource.
l7policy.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
l7policy.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
l7policy.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
l7policy.project_id	body	string	The ID of the project owning this resource.
l7policy.action	body	string	The L7 policy action. One of `REDIRECT_PREFIX`, `REDIRECT_TO_POOL`, `REDIRECT_TO_URL`, or `REJECT`.
l7policy.listener_id	body	string	The ID of the listener.
l7policy.redirect_pool_id	body	string	Requests matching this policy will be redirected to the pool with this ID. Only valid if `action` is `REDIRECT_TO_POOL`. The pool has some restrictions, See Protocol Combinations (Listener/Pool).
l7policy.redirect_url	body	string	Requests matching this policy will be redirected to this URL. Only valid if `action` is `REDIRECT_TO_URL`.
l7policy.redirect_prefix	body	string	Requests matching this policy will be redirected to this Prefix URL. Only valid if `action` is `REDIRECT_PREFIX`.
l7policy.position	body	integer	The position of this policy on the listener. Positions start at 1.
l7policy.created_at	body	string	The UTC date and timestamp when the resource was created.
l7policy.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
l7policy.redirect_http_code	body	integer	Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if `action` is `REDIRECT_TO_URL` or `REDIRECT_PREFIX`. Valid options are: 301, 302, 303, 307, or 308. Default is 302. New in version 2.9
l7policy.tenant_id	body	string

404¶

Error

healthmonitors¶

GET

/v2/lbaas/healthmonitors/{healthmonitor_id}

Show Health Monitor details

Shows the details of a health monitor.

If you are not an administrative user and the parent load balancer does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
healthmonitor	body	object	Defines which attributes are to be shown on any response.
healthmonitor.id	body	string	The associated health monitor ID.
healthmonitor.name	body	string	Human-readable name of the resource.
healthmonitor.type	body	string	The type of health monitor. One of `HTTP`, `HTTPS`, `PING`, `SCTP`, `TCP`, `TLS-HELLO`, or `UDP-CONNECT`.
healthmonitor.delay	body	integer	The time, in seconds, between sending probes to members.
healthmonitor.timeout	body	integer	The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.
healthmonitor.max_retries	body	integer	The number of successful checks before changing the `operating status` of the member to `ONLINE`. A valid value is from `1` to `10`.
healthmonitor.max_retries_down	body	integer	The number of allowed check failures before changing the `operating status` of the member to `ERROR`. A valid value is from `1` to `10`.
healthmonitor.http_method	body	string	The HTTP method that the health monitor uses for requests. One of `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, or `TRACE`.
healthmonitor.url_path	body	string	The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (`/`).
healthmonitor.expected_codes	body	string	The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: A single value, such as `200` A list, such as `200, 202` A range, such as `200-204`
healthmonitor.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
healthmonitor.project_id	body	string	The ID of the project owning this resource.
healthmonitor.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
healthmonitor.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
healthmonitor.created_at	body	string	The UTC date and timestamp when the resource was created.
healthmonitor.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
healthmonitor.http_version	body	number	The HTTP version. One of `1.0` or `1.1`. The default is `1.0`. New in version 2.10
healthmonitor.domain_name	body	string	The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check. New in version 2.10
healthmonitor.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/healthmonitors/{healthmonitor_id}

Update a Health Monitor

Update an existing health monitor.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the health monitor provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the health monitor object for changes.

This operation returns the updated health monitor object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
healthmonitor_id	path	string	healthmonitor_id parameter for /v2/lbaas/healthmonitors/{healthmonitor_id} API
healthmonitor	body	object	Defines attributes that are acceptable of a PUT request.
healthmonitor.name	body	string	Human-readable name of the resource.
healthmonitor.delay	body	integer	The time, in seconds, between sending probes to members.
healthmonitor.timeout	body	integer	The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.
healthmonitor.max_retries_down	body	integer	The number of allowed check failures before changing the `operating status` of the member to `ERROR`. A valid value is from `1` to `10`. The default is `3`.
healthmonitor.max_retries	body	integer	The number of successful checks before changing the `operating status` of the member to `ONLINE`. A valid value is from `1` to `10`.
healthmonitor.http_method	body	string	The HTTP method that the health monitor uses for requests. One of `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, or `TRACE`. The default is `GET`.
healthmonitor.url_path	body	string	The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (`/`). The default URL path is `/`.
healthmonitor.expected_codes	body	string	The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: A single value, such as `200` A list, such as `200, 202` A range, such as `200-204` The default is 200.
healthmonitor.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
healthmonitor.http_version	body	number	The HTTP version. One of `1.0` or `1.1`. The default is `1.0`. New in version 2.10
healthmonitor.domain_name	body	string	The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check. New in version 2.10

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "healthmonitor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "delay": {
          "type": "integer",
          "description": "The time, in seconds, between sending probes to members."
        },
        "timeout": {
          "type": "integer",
          "description": "The maximum time, in seconds, that a monitor waits to connect before it\ntimes out. This value must be less than the delay value."
        },
        "max_retries_down": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10,
          "description": "The number of allowed check failures before changing the `operating\nstatus` of the member to `ERROR`. A valid value is from `1` to `10`.\nThe default is `3`."
        },
        "max_retries": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10,
          "description": "The number of successful checks before changing the `operating status`\nof the member to `ONLINE`. A valid value is from `1` to `10`."
        },
        "http_method": {
          "type": "string",
          "enum": [
            "HEAD",
            "POST",
            "CONNECT",
            "OPTIONS",
            "PATCH",
            "PUT",
            "DELETE",
            "TRACE",
            "GET"
          ],
          "description": "The HTTP method that the health monitor uses for requests. One of\n`CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`,\n`POST`, `PUT`, or `TRACE`. The default is `GET`."
        },
        "url_path": {
          "type": "string",
          "format": "url_path",
          "description": "The HTTP URL path of the request sent by the monitor to test the health of\na backend member. Must be a string that begins with a forward slash\n(`/`). The default URL path is `/`."
        },
        "expected_codes": {
          "type": "string",
          "description": "The list of HTTP status codes expected in response from the member to\ndeclare it healthy. Specify one of the following values:\n\n\n* A single value, such as `200`\n* A list, such as `200, 202`\n* A range, such as `200-204`\n\n\nThe default is 200."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "http_version": {
          "type": "number",
          "enum": [
            1.0,
            1.1
          ],
          "description": "The HTTP version. One of `1.0` or `1.1`. The default is `1.0`.\n\n\n**New in version 2.10**"
        },
        "domain_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The domain name, which be injected into the HTTP Host Header to the backend\nserver for HTTP health check.\n\n\n**New in version 2.10**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
healthmonitor	body	object	Defines which attributes are to be shown on any response.
healthmonitor.id	body	string	The associated health monitor ID.
healthmonitor.name	body	string	Human-readable name of the resource.
healthmonitor.type	body	string	The type of health monitor. One of `HTTP`, `HTTPS`, `PING`, `SCTP`, `TCP`, `TLS-HELLO`, or `UDP-CONNECT`.
healthmonitor.delay	body	integer	The time, in seconds, between sending probes to members.
healthmonitor.timeout	body	integer	The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.
healthmonitor.max_retries	body	integer	The number of successful checks before changing the `operating status` of the member to `ONLINE`. A valid value is from `1` to `10`.
healthmonitor.max_retries_down	body	integer	The number of allowed check failures before changing the `operating status` of the member to `ERROR`. A valid value is from `1` to `10`.
healthmonitor.http_method	body	string	The HTTP method that the health monitor uses for requests. One of `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, or `TRACE`.
healthmonitor.url_path	body	string	The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (`/`).
healthmonitor.expected_codes	body	string	The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: A single value, such as `200` A list, such as `200, 202` A range, such as `200-204`
healthmonitor.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
healthmonitor.project_id	body	string	The ID of the project owning this resource.
healthmonitor.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
healthmonitor.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
healthmonitor.created_at	body	string	The UTC date and timestamp when the resource was created.
healthmonitor.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
healthmonitor.http_version	body	number	The HTTP version. One of `1.0` or `1.1`. The default is `1.0`. New in version 2.10
healthmonitor.domain_name	body	string	The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check. New in version 2.10
healthmonitor.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/healthmonitors/{healthmonitor_id}

Remove a Health Monitor

Removes a health monitor and its associated configuration from the project.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/healthmonitors

List Health Monitors

Lists all health monitors for the project.

Administrative users can specify a project ID that is different than their own to list health monitors for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/healthmonitors

Create Health Monitor

Creates a health monitor on a pool.

Health monitors define how the load balancer monitors backend servers to determine if they are available to service requests.

This operation provisions a new health monitor by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object that contains a unique ID and the status of provisioning the health monitor.

In the response, the health monitor provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/healthmonitors/{healthmonitor_id} to view the progress of the provisioning operation. When the health monitor status changes to ACTIVE, the health monitor is successfully provisioned and is ready for further configuration.

Specifying a project_id is deprecated. The health monitor will inherit the project_id of the parent load balancer.

At a minimum, you must specify these health monitor attributes:

Some attributes receive default values if you omit them from the request:

To create a health monitor, the parent load balancer must have an ACTIVE provisioning status.

Request¶

Description

Name	Location	Type	Description
healthmonitor	body	object	Defines mandatory and optional attributes of a POST request.
healthmonitor.name	body	string	Human-readable name of the resource.
healthmonitor.type	body	string	The type of health monitor. One of `HTTP`, `HTTPS`, `PING`, `SCTP`, `TCP`, `TLS-HELLO`, or `UDP-CONNECT`.
healthmonitor.delay	body	integer	The time, in seconds, between sending probes to members.
healthmonitor.timeout	body	integer	The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.
healthmonitor.max_retries_down	body	integer	The number of allowed check failures before changing the `operating status` of the member to `ERROR`. A valid value is from `1` to `10`. The default is `3`.
healthmonitor.max_retries	body	integer	The number of successful checks before changing the `operating status` of the member to `ONLINE`. A valid value is from `1` to `10`.
healthmonitor.http_method	body	string	The HTTP method that the health monitor uses for requests. One of `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, or `TRACE`. The default is `GET`.
healthmonitor.url_path	body	string	The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (`/`). The default URL path is `/`.
healthmonitor.expected_codes	body	string	The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: A single value, such as `200` A list, such as `200, 202` A range, such as `200-204` The default is 200.
healthmonitor.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
healthmonitor.project_id	body	string	The ID of the project owning this resource. (deprecated)
healthmonitor.pool_id	body	string	The ID of the pool.
healthmonitor.http_version	body	number	The HTTP version. One of `1.0` or `1.1`. The default is `1.0`. New in version 2.10
healthmonitor.domain_name	body	string	The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check. New in version 2.10
healthmonitor.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "healthmonitor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "type": {
          "type": "string",
          "enum": [
            "HTTP",
            "SCTP",
            "UDP-CONNECT",
            "TLS-HELLO",
            "TCP",
            "HTTPS",
            "PING"
          ],
          "description": "The type of health monitor. One of `HTTP`, `HTTPS`, `PING`,\n`SCTP`, `TCP`, `TLS-HELLO`, or `UDP-CONNECT`."
        },
        "delay": {
          "type": "integer",
          "description": "The time, in seconds, between sending probes to members."
        },
        "timeout": {
          "type": "integer",
          "description": "The maximum time, in seconds, that a monitor waits to connect before it\ntimes out. This value must be less than the delay value."
        },
        "max_retries_down": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10,
          "description": "The number of allowed check failures before changing the `operating\nstatus` of the member to `ERROR`. A valid value is from `1` to `10`.\nThe default is `3`."
        },
        "max_retries": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10,
          "description": "The number of successful checks before changing the `operating status`\nof the member to `ONLINE`. A valid value is from `1` to `10`."
        },
        "http_method": {
          "type": "string",
          "enum": [
            "HEAD",
            "POST",
            "CONNECT",
            "OPTIONS",
            "PATCH",
            "PUT",
            "DELETE",
            "TRACE",
            "GET"
          ],
          "description": "The HTTP method that the health monitor uses for requests. One of\n`CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`,\n`POST`, `PUT`, or `TRACE`. The default is `GET`."
        },
        "url_path": {
          "type": "string",
          "format": "url_path",
          "description": "The HTTP URL path of the request sent by the monitor to test the health of\na backend member. Must be a string that begins with a forward slash\n(`/`). The default URL path is `/`."
        },
        "expected_codes": {
          "type": "string",
          "description": "The list of HTTP status codes expected in response from the member to\ndeclare it healthy. Specify one of the following values:\n\n\n* A single value, such as `200`\n* A list, such as `200, 202`\n* A range, such as `200-204`\n\n\nThe default is 200."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource. (deprecated)"
        },
        "pool_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the pool."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "http_version": {
          "type": "number",
          "enum": [
            1.0,
            1.1
          ],
          "description": "The HTTP version. One of `1.0` or `1.1`. The default is `1.0`.\n\n\n**New in version 2.10**"
        },
        "domain_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The domain name, which be injected into the HTTP Host Header to the backend\nserver for HTTP health check.\n\n\n**New in version 2.10**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "max_retries",
        "pool_id",
        "type",
        "delay",
        "timeout"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
healthmonitor	body	object	Defines which attributes are to be shown on any response.
healthmonitor.id	body	string	The associated health monitor ID.
healthmonitor.name	body	string	Human-readable name of the resource.
healthmonitor.type	body	string	The type of health monitor. One of `HTTP`, `HTTPS`, `PING`, `SCTP`, `TCP`, `TLS-HELLO`, or `UDP-CONNECT`.
healthmonitor.delay	body	integer	The time, in seconds, between sending probes to members.
healthmonitor.timeout	body	integer	The maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.
healthmonitor.max_retries	body	integer	The number of successful checks before changing the `operating status` of the member to `ONLINE`. A valid value is from `1` to `10`.
healthmonitor.max_retries_down	body	integer	The number of allowed check failures before changing the `operating status` of the member to `ERROR`. A valid value is from `1` to `10`.
healthmonitor.http_method	body	string	The HTTP method that the health monitor uses for requests. One of `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, or `TRACE`.
healthmonitor.url_path	body	string	The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (`/`).
healthmonitor.expected_codes	body	string	The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: A single value, such as `200` A list, such as `200, 202` A range, such as `200-204`
healthmonitor.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
healthmonitor.project_id	body	string	The ID of the project owning this resource.
healthmonitor.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
healthmonitor.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
healthmonitor.created_at	body	string	The UTC date and timestamp when the resource was created.
healthmonitor.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
healthmonitor.http_version	body	number	The HTTP version. One of `1.0` or `1.1`. The default is `1.0`. New in version 2.10
healthmonitor.domain_name	body	string	The domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check. New in version 2.10
healthmonitor.tenant_id	body	string

404¶

Error

quotas¶

GET

/v2/lbaas/quotas/{project_id}

Show Project Quota

Show the quota for the project.

Administrative users can specify a project ID that is different than their own to show quota for other projects.

A quota of -1 means the quota is unlimited.

Responses¶

200¶

Name	Location	Type	Description
quota	body	object	Individual quota definitions.
quota.loadbalancer	body	integer	The configured load balancer quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.load_balancer	body	integer
quota.listener	body	integer	The configured listener quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.member	body	integer	The configured member quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.pool	body	integer	The configured pool quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.healthmonitor	body	integer	The configured health monitor quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.health_monitor	body	integer
quota.l7policy	body	integer	The configured l7policy quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.l7rule	body	integer	The configured l7rule quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.

404¶

Error

PUT

/v2/lbaas/quotas/{project_id}

Update a Quota

Updates a quota for a project.

If the request is valid, the service returns the Accepted (202) response code.

This operation returns the updated quota object.

If the quota is specified as null the quota will use the deployment default quota settings.

Specifying a quota of -1 means the quota is unlimited.

Specifying a quota of 0 means the project cannot create any of the resource.

Request¶

Description

Name	Location	Type	Description
project_id	path	string	project_id parameter for /v2/lbaas/quotas/{project_id} API
quota	body	object	Individual quota definitions.
quota.loadbalancer	body	integer	The configured load balancer quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.load_balancer	body	integer
quota.listener	body	integer	The configured listener quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.member	body	integer	The configured member quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.pool	body	integer	The configured pool quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.healthmonitor	body	integer	The configured health monitor quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.health_monitor	body	integer
quota.l7policy	body	integer	The configured l7policy quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.l7rule	body	integer	The configured l7rule quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.

Schema

{
  "type": "object",
  "description": "Overall object for quota PUT request.",
  "properties": {
    "quota": {
      "type": "object",
      "properties": {
        "loadbalancer": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured load balancer quota limit. A setting of `null` means it\nis using the deployment default quota. A setting of `-1` means\nunlimited."
        },
        "load_balancer": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000
        },
        "listener": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured listener quota limit. A setting of `null` means it is\nusing the deployment default quota. A setting of `-1` means unlimited."
        },
        "member": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured member quota limit. A setting of `null` means it is using\nthe deployment default quota. A setting of `-1` means unlimited."
        },
        "pool": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured pool quota limit. A setting of `null` means it is using\nthe deployment default quota. A setting of `-1` means unlimited."
        },
        "healthmonitor": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured health monitor quota limit. A setting of `null` means it\nis using the deployment default quota. A setting of `-1` means\nunlimited."
        },
        "health_monitor": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000
        },
        "l7policy": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured l7policy quota limit. A setting of `null` means it is\nusing the deployment default quota. A setting of `-1` means unlimited."
        },
        "l7rule": {
          "type": "integer",
          "minimum": -1,
          "maximum": 2000000000,
          "description": "The configured l7rule quota limit. A setting of `null` means it is\nusing the deployment default quota. A setting of `-1` means unlimited."
        }
      },
      "description": "Individual quota definitions."
    }
  }
}

Responses¶

202¶

Name	Location	Type	Description
quota	body	object	Individual quota definitions.
quota.loadbalancer	body	integer	The configured load balancer quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.load_balancer	body	integer
quota.listener	body	integer	The configured listener quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.member	body	integer	The configured member quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.pool	body	integer	The configured pool quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.healthmonitor	body	integer	The configured health monitor quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.health_monitor	body	integer
quota.l7policy	body	integer	The configured l7policy quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.
quota.l7rule	body	integer	The configured l7rule quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited.

404¶

Error

DELETE

/v2/lbaas/quotas/{project_id}

Reset a Quota

Resets a project quota to use the deployment default quota.

Responses¶

202¶

404¶

Error

GET

/v2/lbaas/quotas

List Quota

Lists all quotas for the project.

Administrative users can specify a project ID that is different than their own to list quotas for other projects.

If the quota is listed as null the quota is using the deployment default quota settings.

A quota of -1 means the quota is unlimited.

The list might be empty.

Responses¶

200¶

404¶

Error

providers¶

GET

/v2/lbaas/providers

List Providers

Lists all enabled provider drivers.

Use the fields query parameter to control which fields are returned in the response body.

The list might be empty.

Responses¶

200¶

404¶

Error

GET

/v2/lbaas/providers/{provider}/flavor_capabilities

Show Provider Flavor Capabilities

Shows the provider driver flavor capabilities. These are the features of the provider driver that can be configured in an Octavia flavor. This API returns a list of dictionaries with the name and description of each flavor capability of the provider.

The list might be empty and a provider driver may not implement this feature.

New in version 2.6

Responses¶

200¶

404¶

Error

GET

/v2/lbaas/providers/{provider}/availability_zone_capabilities

Show Provider Availability Zone Capabilities

Shows the provider driver availability zone capabilities. These are the features of the provider driver that can be configured in an Octavia availability zone. This API returns a list of dictionaries with the name and description of each availability zone capability of the provider.

The list might be empty and a provider driver may not implement this feature.

New in version 2.14

Responses¶

200¶

404¶

Error

flavors¶

GET

/v2/lbaas/flavors/{flavor_id}

Gets a flavor’s detail.

Responses¶

200¶

Name	Location	Type	Description
flavor	body	object	Defines which attributes are to be shown on any response.
flavor.id	body	string
flavor.name	body	string
flavor.description	body	string
flavor.enabled	body	boolean
flavor.flavor_profile_id	body	string

404¶

Error

PUT

/v2/lbaas/flavors/{flavor_id}

Base type for complex types

Request¶

Description

Name	Location	Type	Description
flavor_id	path	string	flavor_id parameter for /v2/lbaas/flavors/{flavor_id} API
flavor	body	object	Defines the attributes of a PUT request.
flavor.name	body	string
flavor.description	body	string
flavor.enabled	body	boolean

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "flavor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        },
        "enabled": {
          "type": "boolean"
        }
      },
      "description": "Defines the attributes of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
flavor	body	object	Defines which attributes are to be shown on any response.
flavor.id	body	string
flavor.name	body	string
flavor.description	body	string
flavor.enabled	body	boolean
flavor.flavor_profile_id	body	string

404¶

Error

DELETE

/v2/lbaas/flavors/{flavor_id}

Deletes a Flavor

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/flavors

Lists all flavors.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/flavors

Creates a flavor.

Request¶

Description

Name	Location	Type	Description
flavor	body	object	Defines mandatory and optional attributes of a POST request.
flavor.name	body	string
flavor.description	body	string
flavor.enabled	body	boolean
flavor.flavor_profile_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "flavor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        },
        "enabled": {
          "type": "boolean"
        },
        "flavor_profile_id": {
          "type": "string",
          "format": "uuid"
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "flavor_profile_id",
        "name"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
flavor	body	object	Defines which attributes are to be shown on any response.
flavor.id	body	string
flavor.name	body	string
flavor.description	body	string
flavor.enabled	body	boolean
flavor.flavor_profile_id	body	string

404¶

Error

flavor-profiles¶

GET

/v2/lbaas/flavorprofiles/{flavorprofile_id}

Gets a flavor profile’s detail.

Responses¶

200¶

Name	Location	Type	Description
flavorprofile	body	object	Defines which attributes are to be shown on any response.
flavorprofile.id	body	string
flavorprofile.name	body	string
flavorprofile.provider_name	body	string
flavorprofile.flavor_data	body	string

404¶

Error

PUT

/v2/lbaas/flavorprofiles/{flavorprofile_id}

Updates a flavor Profile.

Request¶

Description

Name	Location	Type	Description
flavorprofile_id	path	string	flavorprofile_id parameter for /v2/lbaas/flavorprofiles/{flavorprofile_id} API
flavorprofile	body	object	Defines the attributes of a PUT request.
flavorprofile.name	body	string
flavorprofile.provider_name	body	string
flavorprofile.flavor_data	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "flavorprofile": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "provider_name": {
          "type": "string",
          "maxLength": 255
        },
        "flavor_data": {
          "type": "string",
          "maxLength": 4096
        }
      },
      "description": "Defines the attributes of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
flavorprofile	body	object	Defines which attributes are to be shown on any response.
flavorprofile.id	body	string
flavorprofile.name	body	string
flavorprofile.provider_name	body	string
flavorprofile.flavor_data	body	string

404¶

Error

DELETE

/v2/lbaas/flavorprofiles/{flavorprofile_id}

Deletes a Flavor Profile

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/flavorprofiles

Lists all flavor profiles.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/flavorprofiles

Creates a flavor Profile.

Request¶

Description

Name	Location	Type	Description
flavorprofile	body	object	Defines mandatory and optional attributes of a POST request.
flavorprofile.name	body	string
flavorprofile.provider_name	body	string
flavorprofile.flavor_data	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "flavorprofile": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "provider_name": {
          "type": "string",
          "maxLength": 255
        },
        "flavor_data": {
          "type": "string",
          "maxLength": 4096
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "provider_name",
        "flavor_data",
        "name"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
flavorprofile	body	object	Defines which attributes are to be shown on any response.
flavorprofile.id	body	string
flavorprofile.name	body	string
flavorprofile.provider_name	body	string
flavorprofile.flavor_data	body	string

404¶

Error

availability-zones¶

GET

/v2/lbaas/availabilityzones/{availabilityzone_id}

Gets an Availability Zone’s detail.

Responses¶

200¶

Name	Location	Type	Description
availability_zone	body	object	Defines which attributes are to be shown on any response.
availability_zone.name	body	string
availability_zone.description	body	string
availability_zone.enabled	body	boolean
availability_zone.availability_zone_profile_id	body	string

404¶

Error

PUT

/v2/lbaas/availabilityzones/{availabilityzone_id}

Base type for complex types

Request¶

Description

Name	Location	Type	Description
availabilityzone_id	path	string	availabilityzone_id parameter for /v2/lbaas/availabilityzones/{availabilityzone_id} API
availability_zone	body	object	Defines the attributes of a PUT request.
availability_zone.description	body	string
availability_zone.enabled	body	boolean

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "availability_zone": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "maxLength": 255
        },
        "enabled": {
          "type": "boolean"
        }
      },
      "description": "Defines the attributes of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
availability_zone	body	object	Defines which attributes are to be shown on any response.
availability_zone.name	body	string
availability_zone.description	body	string
availability_zone.enabled	body	boolean
availability_zone.availability_zone_profile_id	body	string

404¶

Error

DELETE

/v2/lbaas/availabilityzones/{availabilityzone_id}

Deletes an Availability Zone

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/availabilityzones

Lists all Availability Zones.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/availabilityzones

Creates an Availability Zone.

Request¶

Description

Name	Location	Type	Description
availability_zone	body	object	Defines mandatory and optional attributes of a POST request.
availability_zone.name	body	string
availability_zone.description	body	string
availability_zone.enabled	body	boolean
availability_zone.availability_zone_profile_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "availability_zone": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        },
        "enabled": {
          "type": "boolean"
        },
        "availability_zone_profile_id": {
          "type": "string",
          "format": "uuid"
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "name",
        "availability_zone_profile_id"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
availability_zone	body	object	Defines which attributes are to be shown on any response.
availability_zone.name	body	string
availability_zone.description	body	string
availability_zone.enabled	body	boolean
availability_zone.availability_zone_profile_id	body	string

404¶

Error

availability-zone-profiles¶

GET

/v2/lbaas/availabilityzoneprofiles/{availabilityzoneprofile_id}

Gets an Availability Zone Profile’s detail.

Responses¶

200¶

Name	Location	Type	Description
availability_zone_profile	body	object	Defines which attributes are to be shown on any response.
availability_zone_profile.id	body	string
availability_zone_profile.name	body	string
availability_zone_profile.provider_name	body	string
availability_zone_profile.availability_zone_data	body	string

404¶

Error

PUT

/v2/lbaas/availabilityzoneprofiles/{availabilityzoneprofile_id}

Updates an Availability Zone Profile.

Request¶

Description

Name	Location	Type	Description
availabilityzoneprofile_id	path	string	availabilityzoneprofile_id parameter for /v2/lbaas/availabilityzoneprofiles/{availabilityzoneprofile_id} API
availability_zone_profile	body	object	Defines the attributes of a PUT request.
availability_zone_profile.name	body	string
availability_zone_profile.provider_name	body	string
availability_zone_profile.availability_zone_data	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "availability_zone_profile": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "provider_name": {
          "type": "string",
          "maxLength": 255
        },
        "availability_zone_data": {
          "type": "string",
          "maxLength": 4096
        }
      },
      "description": "Defines the attributes of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
availability_zone_profile	body	object	Defines which attributes are to be shown on any response.
availability_zone_profile.id	body	string
availability_zone_profile.name	body	string
availability_zone_profile.provider_name	body	string
availability_zone_profile.availability_zone_data	body	string

404¶

Error

DELETE

/v2/lbaas/availabilityzoneprofiles/{availabilityzoneprofile_id}

Deletes an Availability Zone Profile

Responses¶

204¶

404¶

Error

GET

/v2/lbaas/availabilityzoneprofiles

Lists all Availability Zone Profiles.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/availabilityzoneprofiles

Creates an Availability Zone Profile.

Request¶

Description

Name	Location	Type	Description
availability_zone_profile	body	object	Defines mandatory and optional attributes of a POST request.
availability_zone_profile.name	body	string
availability_zone_profile.provider_name	body	string
availability_zone_profile.availability_zone_data	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "availability_zone_profile": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "provider_name": {
          "type": "string",
          "maxLength": 255
        },
        "availability_zone_data": {
          "type": "string",
          "maxLength": 4096
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "provider_name",
        "availability_zone_data",
        "name"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
availability_zone_profile	body	object	Defines which attributes are to be shown on any response.
availability_zone_profile.id	body	string
availability_zone_profile.name	body	string
availability_zone_profile.provider_name	body	string
availability_zone_profile.availability_zone_data	body	string

404¶

Error

octavia¶

GET

/v2/octavia

Responses¶

200¶

404¶

Error

amphorae¶

GET

/v2/octavia/amphorae/{amphora_id}

Show Amphora details

Shows the details of an amphora.

If you are not an administrative user, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
amphora	body	object	Defines which attributes are to be shown on any response.
amphora.id	body	string	The associated amphora ID.
amphora.loadbalancer_id	body	string	The ID of the load balancer.
amphora.compute_id	body	string	The ID of the amphora resource in the compute system.
amphora.lb_network_ip	body	string	The management IP of the amphora.
amphora.vrrp_ip	body	string	The address of the vrrp port on the amphora.
amphora.ha_ip	body	string	The IP address of the Virtual IP (VIP).
amphora.vrrp_port_id	body	string	The vrrp port’s ID in the networking system.
amphora.ha_port_id	body	string	The ID of the Virtual IP (VIP) port.
amphora.cert_expiration	body	string	The date the certificate for the amphora expires.
amphora.cert_busy	body	boolean	Whether the certificate is in the process of being replaced.
amphora.role	body	string	The role of the amphora. One of `STANDALONE`, `MASTER`, `BACKUP`.
amphora.status	body	string	The status of the amphora. One of: `BOOTING`, `ALLOCATED`, `READY`, `PENDING_CREATE`, `PENDING_DELETE`, `DELETED`, `ERROR`.
amphora.vrrp_interface	body	string	The bound interface name of the vrrp port on the amphora.
amphora.vrrp_id	body	integer	The vrrp group’s ID for the amphora.
amphora.vrrp_priority	body	integer	The priority of the amphora in the vrrp group.
amphora.cached_zone	body	string	The availability zone of a compute instance, cached at create time. This is not guaranteed to be current. May be an empty-string if the compute service does not use zones.
amphora.created_at	body	string	The UTC date and timestamp when the resource was created.
amphora.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
amphora.image_id	body	string	The ID of the glance image used for the amphora. New in version 2.1
amphora.compute_flavor	body	string	The ID of the compute flavor used for the amphora. New in version 2.3

404¶

Error

DELETE

/v2/octavia/amphorae/{amphora_id}

Remove an Amphora

Removes an amphora and its associated configuration.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

New in version 2.20

Responses¶

204¶

404¶

Error

GET

/v2/octavia/amphorae

List Amphora

Lists all amphora for the project.

If you are not an administrative user, the service returns the HTTP Forbidden (403) response code.

The list might be empty.

Responses¶

200¶

404¶

Error

GET

/v2/octavia/amphorae/{amphora_id}/stats

Show Amphora Statistics

Show the statistics for an amphora.

If you are not an administrative user, the service returns the HTTP Forbidden (403) response code.

Use the fields query parameter to control which fields are returned in the response body.

New in version 2.3

Responses¶

200¶

404¶

Error

PUT

/v2/octavia/amphorae/{amphora_id}/config

Configure Amphora

Update the amphora agent configuration. This will push the new configuration to the amphora agent and will update the configuration options that are mutatable.

If you are not an administrative user, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

New in version 2.7

Request¶

Description

Name

Location

Type

Description

amphora_id

path

string

amphora_id parameter for /v2/octavia/amphorae/{amphora_id}/failover API

Schema

{
  "type": "object",
  "description": "Request of the octavia/amphorae/amphora_id/config:put operation",
  "x-openstack": {
    "action-name": "config"
  }
}

Responses¶

202¶

404¶

Error

PUT

/v2/octavia/amphorae/{amphora_id}/failover

Failover Amphora

Force an amphora to failover.

If you are not an administrative user, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Request¶

Description

Name

Location

Type

Description

amphora_id

path

string

amphora_id parameter for /v2/octavia/amphorae/{amphora_id}/failover API

Schema

{
  "type": "object",
  "description": "Request of the octavia/amphorae/amphora_id/failover:put operation",
  "x-openstack": {
    "action-name": "failover"
  }
}

Responses¶

202¶

404¶

Error

l7-rules¶

GET

/v2/lbaas/l7policies/{l7policy_id}/rules

List L7 Rules

Lists all L7 rules for the project.

Administrative users can specify a project ID that is different than their own to list L7 policies for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/l7policies/{l7policy_id}/rules

Create an L7 Rule

Creates a L7 rule.

This operation provisions a new L7 rule by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object that contains a unique ID and the status of provisioning the L7 rule.

In the response, the L7 rule provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id} to view the progress of the provisioning operation. When the L7 rule status changes to ACTIVE, the L7 rule is successfully provisioned and is ready for further configuration.

All the rules associated with a given policy are logically ANDead together. A request must match all the policy’s rules to match the policy.

If you need to express a logical OR operation between rules, then do this by creating multiple policies with the same action.

Request¶

Description

Name	Location	Type	Description
l7policy_id	path	string	l7policy_id parameter for /v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id} API
rule	body	object	Defines mandatory and optional attributes of a POST request.
rule.type	body	string	The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`, `HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`, or `SSL_DN_FIELD`.
rule.compare_type	body	string	The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`, `EQUAL_TO`, `REGEX`, or `STARTS_WITH`.
rule.key	body	string	The key to use for the comparison. For example, the name of the cookie to evaluate.
rule.value	body	string	The value to use for the comparison. For example, the file type to compare.
rule.invert	body	boolean	When `true` the logic of the rule is inverted. For example, with invert `true`, equal to would become not equal to. Default is `false`.
rule.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
rule.project_id	body	string	The ID of the project owning this resource.
rule.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "rule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "HEADER",
            "FILE_TYPE",
            "SSL_CONN_HAS_CERT",
            "SSL_VERIFY_RESULT",
            "SSL_DN_FIELD",
            "HOST_NAME",
            "COOKIE",
            "PATH"
          ],
          "description": "The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`,\n`HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`,\nor `SSL_DN_FIELD`."
        },
        "compare_type": {
          "type": "string",
          "enum": [
            "EQUAL_TO",
            "CONTAINS",
            "REGEX",
            "ENDS_WITH",
            "STARTS_WITH"
          ],
          "description": "The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`,\n`EQUAL_TO`, `REGEX`, or `STARTS_WITH`."
        },
        "key": {
          "type": "string",
          "maxLength": 255,
          "description": "The key to use for the comparison. For example, the name of the cookie\nto evaluate."
        },
        "value": {
          "type": "string",
          "maxLength": 255,
          "description": "The value to use for the comparison. For example, the file type to compare."
        },
        "invert": {
          "type": "boolean",
          "description": "When `true` the logic of the rule is inverted. For example, with\ninvert `true`, equal to would become not equal to.\nDefault is `false`."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "value",
        "compare_type",
        "type"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
rule	body	object	Defines which attributes are to be shown on any response.
rule.id	body	string	The ID of the L7 rule.
rule.type	body	string	The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`, `HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`, or `SSL_DN_FIELD`.
rule.compare_type	body	string	The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`, `EQUAL_TO`, `REGEX`, or `STARTS_WITH`.
rule.key	body	string	The key to use for the comparison. For example, the name of the cookie to evaluate.
rule.value	body	string	The value to use for the comparison. For example, the file type to compare.
rule.invert	body	boolean	When `true` the logic of the rule is inverted. For example, with invert `true`, equal to would become not equal to.
rule.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
rule.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
rule.created_at	body	string	The UTC date and timestamp when the resource was created.
rule.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
rule.project_id	body	string	The ID of the project owning this resource.
rule.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
rule.tenant_id	body	string

404¶

Error

GET

/v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id}

Show L7 Rule details

Shows the details of a L7 rule.

If you are not an administrative user and the L7 rule object does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
rule	body	object	Defines which attributes are to be shown on any response.
rule.id	body	string	The ID of the L7 rule.
rule.type	body	string	The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`, `HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`, or `SSL_DN_FIELD`.
rule.compare_type	body	string	The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`, `EQUAL_TO`, `REGEX`, or `STARTS_WITH`.
rule.key	body	string	The key to use for the comparison. For example, the name of the cookie to evaluate.
rule.value	body	string	The value to use for the comparison. For example, the file type to compare.
rule.invert	body	boolean	When `true` the logic of the rule is inverted. For example, with invert `true`, equal to would become not equal to.
rule.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
rule.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
rule.created_at	body	string	The UTC date and timestamp when the resource was created.
rule.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
rule.project_id	body	string	The ID of the project owning this resource.
rule.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
rule.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id}

Update a L7 Rule

Updates a L7 rule.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the L7 rule provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the L7 rule object for changes.

This operation returns the updated L7 rule object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
l7policy_id	path	string	l7policy_id parameter for /v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id} API
rule_id	path	string	rule_id parameter for /v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id} API
rule	body	object	Defines attributes that are acceptable of a PUT request.
rule.type	body	string	The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`, `HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`, or `SSL_DN_FIELD`.
rule.compare_type	body	string	The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`, `EQUAL_TO`, `REGEX`, or `STARTS_WITH`.
rule.key	body	string	The key to use for the comparison. For example, the name of the cookie to evaluate.
rule.value	body	string	The value to use for the comparison. For example, the file type to compare.
rule.invert	body	boolean	When `true` the logic of the rule is inverted. For example, with invert `true`, equal to would become not equal to. Default is `false`.
rule.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "rule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "HEADER",
            "FILE_TYPE",
            "SSL_CONN_HAS_CERT",
            "SSL_VERIFY_RESULT",
            "SSL_DN_FIELD",
            "HOST_NAME",
            "COOKIE",
            "PATH"
          ],
          "description": "The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`,\n`HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`,\nor `SSL_DN_FIELD`."
        },
        "compare_type": {
          "type": "string",
          "enum": [
            "EQUAL_TO",
            "CONTAINS",
            "REGEX",
            "ENDS_WITH",
            "STARTS_WITH"
          ],
          "description": "The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`,\n`EQUAL_TO`, `REGEX`, or `STARTS_WITH`."
        },
        "key": {
          "type": "string",
          "maxLength": 255,
          "description": "The key to use for the comparison. For example, the name of the cookie\nto evaluate."
        },
        "value": {
          "type": "string",
          "maxLength": 255,
          "description": "The value to use for the comparison. For example, the file type to compare."
        },
        "invert": {
          "type": "boolean",
          "description": "When `true` the logic of the rule is inverted. For example, with\ninvert `true`, equal to would become not equal to.\nDefault is `false`."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
rule	body	object	Defines which attributes are to be shown on any response.
rule.id	body	string	The ID of the L7 rule.
rule.type	body	string	The L7 rule type. One of `COOKIE`, `FILE_TYPE`, `HEADER`, `HOST_NAME`, `PATH`, `SSL_CONN_HAS_CERT`, `SSL_VERIFY_RESULT`, or `SSL_DN_FIELD`.
rule.compare_type	body	string	The comparison type for the L7 rule. One of `CONTAINS`, `ENDS_WITH`, `EQUAL_TO`, `REGEX`, or `STARTS_WITH`.
rule.key	body	string	The key to use for the comparison. For example, the name of the cookie to evaluate.
rule.value	body	string	The value to use for the comparison. For example, the file type to compare.
rule.invert	body	boolean	When `true` the logic of the rule is inverted. For example, with invert `true`, equal to would become not equal to.
rule.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
rule.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
rule.created_at	body	string	The UTC date and timestamp when the resource was created.
rule.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
rule.project_id	body	string	The ID of the project owning this resource.
rule.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
rule.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/l7policies/{l7policy_id}/rules/{rule_id}

Remove a L7 Rule

Removes a L7 rule and its associated configuration from the project.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error

members¶

GET

/v2/lbaas/pools/{pool_id}/members

List Members

Lists all members for the project.

Administrative users can specify a project ID that is different than their own to list members for other projects.

The list might be empty.

Responses¶

200¶

404¶

Error

POST

/v2/lbaas/pools/{pool_id}/members

Create Member

This operation provisions a member and adds it to a pool by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, it returns a response object, which contains a unique ID.

In the response, the member provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/pools/{pool_id}/members/{member_id} to view the progress of the provisioning operation. When the member status changes to ACTIVE, the member is successfully provisioned and is ready for further configuration.

At a minimum, you must specify these member attributes:

Some attributes receive default values if you omit them from the request:

If you omit the subnet_id parameter, the vip_subnet_id for the parent load balancer will be used for the member subnet UUID.

The member address does not necessarily need to be a member of the subnet_id subnet. Members can be routable from the subnet specified either via the default route or by using host_routes defined on the subnet.

Administrative users can specify a project ID that is different than their own to create members for other projects.

monitor_address and/or monitor_port can be used to have the health monitor, if one is configured for the pool, connect to an alternate IP address and port when executing a health check on the member.

To create a member, the load balancer must have an ACTIVE provisioning status.

Request¶

Description

Name	Location	Type	Description
pool_id	path	string	pool_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API
member	body	object	Defines mandatory and optional attributes of a POST request.
member.name	body	string	Human-readable name of the resource.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
member.address	body	string	The IP address of the resource.
member.protocol_port	body	integer	The protocol port number for the resource.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.subnet_id	body	string	The subnet ID the member service is accessible from.
member.project_id	body	string	The ID of the project owning this resource. (deprecated)
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.
member.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "address": {
          "type": "string",
          "format": "ipaddress",
          "description": "The IP address of the resource."
        },
        "protocol_port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "description": "The protocol port number for the resource."
        },
        "weight": {
          "type": "integer",
          "maximum": 256,
          "description": "The weight of a member determines the portion of requests or connections it\nservices compared to the other members of the pool. For example, a member\nwith a weight of 10 receives five times as many requests as a member with a\nweight of 2. A value of 0 means the member does not receive new connections\nbut continues to service existing connections. A valid value is\nfrom `0` to `256`. Default is `1`."
        },
        "backup": {
          "type": "boolean",
          "description": "Is the member a backup? Backup members only receive traffic when all\nnon-backup members are down.\n\n\n**New in version 2.1**"
        },
        "subnet_id": {
          "type": "string",
          "format": "uuid",
          "description": "The subnet ID the member service is accessible from."
        },
        "project_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The ID of the project owning this resource. (deprecated)"
        },
        "monitor_port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "description": "An alternate protocol port used for health monitoring a backend member.\nDefault is `null` which monitors the member `protocol_port`."
        },
        "monitor_address": {
          "type": "string",
          "format": "ipaddress",
          "description": "An alternate IP address used for health monitoring a backend member.\nDefault is `null` which monitors the member `address`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 36
        }
      },
      "description": "Defines mandatory and optional attributes of a POST request.",
      "required": [
        "protocol_port",
        "address"
      ]
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
member	body	object	Defines which attributes are to be shown on any response.
member.id	body	string	The ID of the member.
member.name	body	string	Human-readable name of the resource.
member.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
member.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
member.address	body	string	The IP address of the backend member server.
member.protocol_port	body	integer	The protocol port number the backend member server is listening on.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.subnet_id	body	string	The subnet ID the member service is accessible from.
member.project_id	body	string	The ID of the project owning this resource.
member.created_at	body	string	The UTC date and timestamp when the resource was created.
member.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/pools/{pool_id}/members

Batch Update Members

Set the state of members for a pool in one API call. This may include creating new members, deleting old members, and updating existing members. Existing members are matched based on address/port combination.

For example, assume a pool currently has two members. These members have the following address/port combinations: ‘192.0.2.15:80’ and ‘192.0.2.16:80’. Now assume a PUT request is made that includes members with address/port combinations: ‘192.0.2.16:80’ and ‘192.0.2.17:80’.

The member ‘192.0.2.15:80’ will be deleted, because it was not in the request.

The member ‘192.0.2.16:80’ will be updated to match the request data for that member, because it was matched.

The member ‘192.0.2.17:80’ will be created, because no such member existed.

The optional parameter additive_only when defined as true will skip deletions for members missing from the provided list. If this were set in the above example, the member ‘192.0.2.15:80’ would have remained in the pool.

If the request is valid, the service returns the Accepted (202) response code. To confirm the updates, check that the member provisioning statuses are ACTIVE for new or updated members, and that any unspecified members were correctly deleted. If the statuses are PENDING_UPDATE or PENDING_DELETE, use GET to poll the member objects for changes.

Request¶

Description

Name

Location

Type

Description

pool_id

path

string

pool_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "description": "Human-readable name of the resource."
          },
          "admin_state_up": {
            "type": "boolean",
            "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
          },
          "address": {
            "type": "string",
            "format": "ipaddress",
            "description": "The IP address of the resource."
          },
          "protocol_port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "description": "The protocol port number for the resource."
          },
          "weight": {
            "type": "integer",
            "maximum": 256,
            "description": "The weight of a member determines the portion of requests or connections it\nservices compared to the other members of the pool. For example, a member\nwith a weight of 10 receives five times as many requests as a member with a\nweight of 2. A value of 0 means the member does not receive new connections\nbut continues to service existing connections. A valid value is\nfrom `0` to `256`. Default is `1`."
          },
          "backup": {
            "type": "boolean",
            "description": "Is the member a backup? Backup members only receive traffic when all\nnon-backup members are down.\n\n\n**New in version 2.1**"
          },
          "subnet_id": {
            "type": "string",
            "format": "uuid",
            "description": "The subnet ID the member service is accessible from."
          },
          "project_id": {
            "type": "string",
            "maxLength": 36,
            "description": "The ID of the project owning this resource. (deprecated)"
          },
          "monitor_port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "description": "An alternate protocol port used for health monitoring a backend member.\nDefault is `null` which monitors the member `protocol_port`."
          },
          "monitor_address": {
            "type": "string",
            "format": "ipaddress",
            "description": "An alternate IP address used for health monitoring a backend member.\nDefault is `null` which monitors the member `address`."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 255
            },
            "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
          },
          "tenant_id": {
            "type": "string",
            "maxLength": 36
          }
        },
        "description": "Defines mandatory and optional attributes of a POST request.",
        "required": [
          "protocol_port",
          "address"
        ]
      }
    }
  }
}

Responses¶

202¶

Name	Location	Type	Description
member	body	object	Defines which attributes are to be shown on any response.
member.id	body	string	The ID of the member.
member.name	body	string	Human-readable name of the resource.
member.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
member.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
member.address	body	string	The IP address of the backend member server.
member.protocol_port	body	integer	The protocol port number the backend member server is listening on.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.subnet_id	body	string	The subnet ID the member service is accessible from.
member.project_id	body	string	The ID of the project owning this resource.
member.created_at	body	string	The UTC date and timestamp when the resource was created.
member.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.tenant_id	body	string

404¶

Error

GET

/v2/lbaas/pools/{pool_id}/members/{member_id}

Show Member details

Shows the details of a pool member.

If you are not an administrative user and the parent load balancer does not belong to your project, the service returns the HTTP Forbidden (403) response code.

This operation does not require a request body.

Responses¶

200¶

Name	Location	Type	Description
member	body	object	Defines which attributes are to be shown on any response.
member.id	body	string	The ID of the member.
member.name	body	string	Human-readable name of the resource.
member.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
member.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
member.address	body	string	The IP address of the backend member server.
member.protocol_port	body	integer	The protocol port number the backend member server is listening on.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.subnet_id	body	string	The subnet ID the member service is accessible from.
member.project_id	body	string	The ID of the project owning this resource.
member.created_at	body	string	The UTC date and timestamp when the resource was created.
member.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.tenant_id	body	string

404¶

Error

PUT

/v2/lbaas/pools/{pool_id}/members/{member_id}

Update a Member

Update an existing member.

If the request is valid, the service returns the Accepted (202) response code. To confirm the update, check that the member provisioning status is ACTIVE. If the status is PENDING_UPDATE, use a GET operation to poll the member object for changes.

Setting the member weight to 0 means that the member will not receive new requests but will finish any existing connections. This “drains” the backend member of active connections.

This operation returns the updated member object with the ACTIVE, PENDING_UPDATE, or ERROR provisioning status.

Request¶

Description

Name	Location	Type	Description
pool_id	path	string	pool_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API
member_id	path	string	member_id parameter for /v2/lbaas/pools/{pool_id}/members/{member_id} API
member	body	object	Defines attributes that are acceptable of a PUT request.
member.name	body	string	Human-readable name of the resource.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.

Schema

{
  "type": "object",
  "description": "Base type for complex types",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "admin_state_up": {
          "type": "boolean",
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`). Default is `true`."
        },
        "weight": {
          "type": "integer",
          "maximum": 256,
          "description": "The weight of a member determines the portion of requests or connections it\nservices compared to the other members of the pool. For example, a member\nwith a weight of 10 receives five times as many requests as a member with a\nweight of 2. A value of 0 means the member does not receive new connections\nbut continues to service existing connections. A valid value is\nfrom `0` to `256`. Default is `1`."
        },
        "backup": {
          "type": "boolean",
          "description": "Is the member a backup? Backup members only receive traffic when all\nnon-backup members are down.\n\n\n**New in version 2.1**"
        },
        "monitor_port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "description": "An alternate protocol port used for health monitoring a backend member.\nDefault is `null` which monitors the member `protocol_port`."
        },
        "monitor_address": {
          "type": "string",
          "format": "ipaddress",
          "description": "An alternate IP address used for health monitoring a backend member.\nDefault is `null` which monitors the member `address`."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 255
          },
          "description": "A list of simple strings assigned to the resource.\n\n\n**New in version 2.5**"
        }
      },
      "description": "Defines attributes that are acceptable of a PUT request."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
member	body	object	Defines which attributes are to be shown on any response.
member.id	body	string	The ID of the member.
member.name	body	string	Human-readable name of the resource.
member.operating_status	body	string	The operating status of the resource. See Operating Status Codes.
member.provisioning_status	body	string	The provisioning status of the resource. See Provisioning Status Codes.
member.admin_state_up	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
member.address	body	string	The IP address of the backend member server.
member.protocol_port	body	integer	The protocol port number the backend member server is listening on.
member.weight	body	integer	The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from `0` to `256`. Default is `1`.
member.backup	body	boolean	Is the member a backup? Backup members only receive traffic when all non-backup members are down. New in version 2.1
member.subnet_id	body	string	The subnet ID the member service is accessible from.
member.project_id	body	string	The ID of the project owning this resource.
member.created_at	body	string	The UTC date and timestamp when the resource was created.
member.updated_at	body	string	The UTC date and timestamp when the resource was last updated.
member.monitor_address	body	string	An alternate IP address used for health monitoring a backend member. Default is `null` which monitors the member `address`.
member.monitor_port	body	integer	An alternate protocol port used for health monitoring a backend member. Default is `null` which monitors the member `protocol_port`.
member.tenant_id	body	string

404¶

Error

DELETE

/v2/lbaas/pools/{pool_id}/members/{member_id}

Remove a Member

Removes a member and its associated configuration from the pool.

The API immediately purges any and all configuration data, depending on the configuration settings. You cannot recover it.

Responses¶

204¶

404¶

Error