openstack
/
octavia
Code Issues Proposed changes

Add v2 health monitor API section 

This patch adds the health monitor section to the v2 API reference.

Change-Id: I269eb6e457d317e7d942adcc1d957bc96e4a315f
Partial-Bug: #1558385
This commit is contained in:
johnsom 2017-05-11 17:02:57 -07:00 committed by Adam Harwell
parent 63b2b0e1ce
commit 425d6017fd
18 changed files with 701 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
api-ref/source/parameters.yaml
View File

@ -1,12 +1,12 @@
###############################################################################
# Path fields
###############################################################################
cascade-delete:
path-healthmonitor-id:
description: |
If ``true`` will delete all child objects of the load balancer.
The ID of the health monitor to query.
in: path
required: false
type: boolean
required: true
type: string
path-listener-id:
description: |
The ID of the listener to query.
@ -34,6 +34,12 @@ path-pool-id:
###############################################################################
# Query fields
###############################################################################
cascade-delete:
description: |
If ``true`` will delete all child objects of the load balancer.
in: query
required: false
type: boolean
fields:
description: |
The fields that you want the server to return.
@ -206,18 +212,136 @@ flavor-id-optional:
in: body
required: false
type: string
healthmonitor-delay:
description: |
The time, in seconds, between sending probes to members.
in: body
required: true
type: integer
healthmonitor-delay-optional:
description: |
The time, in seconds, between sending probes to members.
in: body
required: false
type: integer
healthmonitor-expected_codes:
description: |
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``
in: body
required: true
type: string
healthmonitor-expected_codes-optional:
description: |
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.
in: body
required: false
type: string
healthmonitor-http_method:
description: |
The HTTP method that the health monitor uses for requests. One of
``CONNECT``, ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``PATCH``,
``POST``, ``PUT``, or ``TRACE``.
in: body
required: true
type: string
healthmonitor-http_method-optional:
description: |
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``.
in: body
required: false
type: string
healthmonitor-id:
description: |
The associated health monitor ID.
in: body
required: true
type: string
healthmonitor-max-retries:
description: |
The number of successful checks before changing the ``operating status``
of the member to ``ONLINE``. A valid value is from ``1`` to ``10``.
in: body
required: true
type: integer
healthmonitor-max-retries-down:
description: |
The number of allowed check failures before changing the ``operating
status`` of the member to ``ERROR``. A valid value is from ``1`` to ``10``.
in: body
required: true
type: integer
healthmonitor-max-retries-down-optional:
description: |
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``.
in: body
required: false
type: integer
healthmonitor-max-retries-optional:
description: |
The number of successful checks before changing the ``operating status``
of the member to ``ONLINE``. A valid value is from ``1`` to ``10``.
in: body
required: false
type: integer
healthmonitor-status:
description: |
The associated health monitor status object.
in: body
required: true
type: object
healthmonitor-timeout:
description: |
The maximum time, in seconds, that a monitor waits to connect before it
times out. This value must be less than the delay value.
in: body
required: true
type: integer
healthmonitor-timeout-optional:
description: |
The maximum time, in seconds, that a monitor waits to connect before it
times out. This value must be less than the delay value.
in: body
required: false
type: integer
healthmonitor-type:
description: |
The type of health monitor. One of ``HTTP``, ``HTTPS``, ``PING``, or
``TCP``.
in: body
required: true
type: string
healthmonitor-url_path:
description: |
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
(``/``).
in: body
required: true
type: string
healthmonitor-url_path-optional:
description: |
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 ``/``.
in: body
required: false
type: string
id:
description: |
The ID of the resource.

1
api-ref/source/v2/examples/healthmonitor-create-curl Normal file
View File

@ -0,0 +1 @@
curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: <token>" -d '{"healthmonitor":{"name":"super-pool-health-monitor","admin_state_up":true,"pool_id":"4029d267-3983-4224-a3d0-afb3fe16a2cd","delay":"10","expected_codes":"200","max_retries":"1","http_method":"GET","timeout":"5","url_path":"/","type":"HTTP","max_retries_down":3}}' http://198.51.100.10:9876/v2.0/lbaas/healthmonitors

15
api-ref/source/v2/examples/healthmonitor-create-request.json Normal file
View File

@ -0,0 +1,15 @@
{
"healthmonitor": {
"name": "super-pool-health-monitor",
"admin_state_up": true,
"pool_id": "4029d267-3983-4224-a3d0-afb3fe16a2cd",
"delay": "10",
"expected_codes": "200",
"max_retries": "1",
"http_method": "GET",
"timeout": "5",
"url_path": "/",
"type": "HTTP",
"max_retries_down": 3
}
}

25
api-ref/source/v2/examples/healthmonitor-create-response.json Normal file
View File

@ -0,0 +1,25 @@
{
"healthmonitor": {
"project_id": "e3cd678b11784734bc366148aa37580e",
"name": "super-pool-health-monitor",
"admin_state_up": true,
"pools": [
{
"id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
}
],
"created_at": "2017-05-11T23:53:47",
"provisioning_status": "ACTIVE",
"updated_at": "2017-05-11T23:53:47",
"delay": 10,
"expected_codes": "200",
"max_retries": 1,
"http_method": "GET",
"timeout": 5,
"max_retries_down": 3,
"url_path": "/",
"type": "HTTP",
"id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
"operating_status": "ONLINE"
}
}

1
api-ref/source/v2/examples/healthmonitor-delete-curl Normal file
View File

@ -0,0 +1 @@
curl -X DELETE -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2.0/lbaas/healthmonitors/8ed3c5ac-6efa-420c-bedb-99ba14e58db5

1
api-ref/source/v2/examples/healthmonitor-list-curl Normal file
View File

@ -0,0 +1 @@
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2.0/lbaas/healthmonitors?project_id=e3cd678b11784734bc366148aa37580e

1
api-ref/source/v2/examples/healthmonitor-show-curl Normal file
View File

@ -0,0 +1 @@
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2.0/lbaas/healthmonitors/8ed3c5ac-6efa-420c-bedb-99ba14e58db5

25
api-ref/source/v2/examples/healthmonitor-show-response.json Normal file
View File

@ -0,0 +1,25 @@
{
"healthmonitor": {
"project_id": "e3cd678b11784734bc366148aa37580e",
"name": "super-pool-health-monitor",
"admin_state_up": true,
"pools": [
{
"id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
}
],
"created_at": "2017-05-11T23:53:47",
"provisioning_status": "ACTIVE",
"updated_at": "2017-05-11T23:53:47",
"delay": 10,
"expected_codes": "200",
"max_retries": 1,
"http_method": "GET",
"timeout": 5,
"max_retries_down": 3,
"url_path": "/",
"type": "HTTP",
"id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
"operating_status": "ONLINE"
}
}

1
api-ref/source/v2/examples/healthmonitor-update-curl Normal file
View File

@ -0,0 +1 @@
curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: <token>" -d '{"healthmonitor":{"name":"super-pool-health-monitor-updated","admin_state_up":true,"delay":5,"expected_codes":"200","http_method":"HEAD","timeout":2,"url_path":"/index.html","max_retries":2,"max_retries_down":2}}' http://198.51.100.10:9876/v2.0/lbaas/healthmonitors/8ed3c5ac-6efa-420c-bedb-99ba14e58db5

13
api-ref/source/v2/examples/healthmonitor-update-request.json Normal file
View File

@ -0,0 +1,13 @@
{
"healthmonitor": {
"name": "super-pool-health-monitor-updated",
"admin_state_up": true,
"delay": 5,
"expected_codes": "200",
"http_method": "HEAD",
"timeout": 2,
"url_path": "/index.html",
"max_retries": 2,
"max_retries_down": 2
}
}

25
api-ref/source/v2/examples/healthmonitor-update-response.json Normal file
View File

@ -0,0 +1,25 @@
{
"healthmonitor": {
"project_id": "e3cd678b11784734bc366148aa37580e",
"name": "super-pool-health-monitor-updated",
"admin_state_up": true,
"pools": [
{
"id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
}
],
"created_at": "2017-05-11T23:53:47",
"provisioning_status": "PENDING_UPDATE",
"updated_at": "2017-05-11T23:53:47",
"delay": 5,
"expected_codes": "200",
"max_retries": 2,
"http_method": "HEAD",
"timeout": 2,
"max_retries_down": 2,
"url_path": "/index.html",
"type": "HTTP",
"id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
"operating_status": "ONLINE"
}
}

27
api-ref/source/v2/examples/healthmonitors-list-response.json Normal file
View File

@ -0,0 +1,27 @@
{
"healthmonitors": [
{
"project_id": "e3cd678b11784734bc366148aa37580e",
"name": "super-pool-health-monitor",
"admin_state_up": true,
"pools": [
{
"id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
}
],
"created_at": "2017-05-11T23:53:47",
"provisioning_status": "ACTIVE",
"updated_at": "2017-05-11T23:53:47",
"delay": 10,
"expected_codes": "200",
"max_retries": 1,
"http_method": "GET",
"timeout": 5,
"max_retries_down": 3,
"url_path": "/",
"type": "HTTP",
"id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
"operating_status": "ONLINE"
}
]
}

399
api-ref/source/v2/healthmonitor.inc Normal file
View File

@ -0,0 +1,399 @@
.. -*- rst -*-
List Health Monitors
====================
.. rest_method:: GET /v2.0/lbaas/healthmonitors
Lists all health monitors 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 :ref:`filtering`.
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.
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- fields: fields
- project_id: project_id_query
Curl Example
------------
.. literalinclude:: examples/healthmonitor-list-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- created_at: created_at
- delay: healthmonitor-delay
- expected_codes: healthmonitor-expected_codes
- http_method: healthmonitor-http_method
- id: healthmonitor-id
- max_retries: healthmonitor-max-retries
- max_retries_down: healthmonitor-max-retries-down
- name: name
- operating_status: operating_status
- pool_id: pool-id
- project_id: project_id
- provisioning_status: provisioning_status
- timeout: healthmonitor-timeout
- type: healthmonitor-type
- updated_at: updated_at
- url_path: healthmonitor-url_path
Response Example
----------------
.. literalinclude:: examples/healthmonitors-list-response.json
:language: javascript
Create Health Monitor
=====================
.. rest_method:: POST /v2.0/lbaas/healthmonitors
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 :ref:`provisioning status<prov_status>` is
``ACTIVE``, ``PENDING_CREATE``, or ``ERROR``.
If the status is ``PENDING_CREATE``, issue GET
``/v2.0/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.
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.
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:
- ``delay`` The interval, in seconds, between health checks.
- ``max_retries`` The number of successful checks before changing the
operating status of the member to ONLINE.
- ``pool_id`` The pool to monitor.
- ``timeout`` The time, in seconds, after which a health check
times out.
- ``type`` The type of health monitor. One of ``HTTP``, ``HTTPS``, ``PING``,
or ``TCP``.
Some attributes receive default values if you omit them from the request:
- ``admin_state_up`` The default is ``true``.
- ``expected_codes`` The expected HTTP status codes to get from a
successful health check. The default is ``200``.
- ``http_method`` The default is ``GET``.
- ``max_retries_down`` The default is ``3``.
- ``url_path`` The default is ``/``.
To create a health monitor, the parent load balancer must have an ``ACTIVE``
provisioning status.
.. rest_status_code:: success ../http-status.yaml
- 201
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 500
- 503
Request
-------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up-default-optional
- delay: healthmonitor-delay
- expected_codes: healthmonitor-expected_codes-optional
- http_method: healthmonitor-http_method-optional
- name: name-optional
- max_retries: healthmonitor-max-retries
- max_retries_down: healthmonitor-max-retries-down-optional
- pool_id: pool-id
- project_id: project_id-optional-deprecated
- timeout: healthmonitor-timeout
- type: healthmonitor-type
- url_path: healthmonitor-url_path-optional
Request Example
----------------
.. literalinclude:: examples/healthmonitor-create-request.json
:language: javascript
Curl Example
------------
.. literalinclude:: examples/healthmonitor-create-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- created_at: created_at
- delay: healthmonitor-delay
- expected_codes: healthmonitor-expected_codes
- http_method: healthmonitor-http_method
- id: healthmonitor-id
- max_retries: healthmonitor-max-retries
- max_retries_down: healthmonitor-max-retries-down
- name: name
- operating_status: operating_status
- pool_id: pool-id
- project_id: project_id
- provisioning_status: provisioning_status
- timeout: healthmonitor-timeout
- type: healthmonitor-type
- updated_at: updated_at
- url_path: healthmonitor-url_path
Response Example
----------------
.. literalinclude:: examples/healthmonitor-create-response.json
:language: javascript
Show Health Monitor details
===========================
.. rest_method:: GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}
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.
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 401
- 403
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- fields: fields
- healthmonitor_id: path-healthmonitor-id
Curl Example
------------
.. literalinclude:: examples/healthmonitor-show-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- created_at: created_at
- delay: healthmonitor-delay
- expected_codes: healthmonitor-expected_codes
- http_method: healthmonitor-http_method
- id: healthmonitor-id
- max_retries: healthmonitor-max-retries
- max_retries_down: healthmonitor-max-retries-down
- name: name
- operating_status: operating_status
- pool_id: pool-id
- project_id: project_id
- provisioning_status: provisioning_status
- timeout: healthmonitor-timeout
- type: healthmonitor-type
- updated_at: updated_at
- url_path: healthmonitor-url_path
Response Example
----------------
.. literalinclude:: examples/healthmonitor-show-response.json
:language: javascript
Update a Health Monitor
=======================
.. rest_method:: PUT /v2.0/lbaas/healthmonitors/{healthmonitor_id}
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.
.. rest_status_code:: success ../http-status.yaml
- 202
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 409
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up-default-optional
- delay: healthmonitor-delay-optional
- expected_codes: healthmonitor-expected_codes-optional
- healthmonitor_id: path-healthmonitor-id
- http_method: healthmonitor-http_method-optional
- max_retries: healthmonitor-max-retries-optional
- max_retries_down: healthmonitor-max-retries-down-optional
- name: name-optional
- timeout: healthmonitor-timeout-optional
- url_path: healthmonitor-url_path-optional
Request Example
---------------
.. literalinclude:: examples/healthmonitor-update-request.json
:language: javascript
Curl Example
------------
.. literalinclude:: examples/healthmonitor-update-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- created_at: created_at
- delay: healthmonitor-delay
- expected_codes: healthmonitor-expected_codes
- http_method: healthmonitor-http_method
- id: healthmonitor-id
- max_retries: healthmonitor-max-retries
- max_retries_down: healthmonitor-max-retries-down
- name: name
- operating_status: operating_status
- pool_id: pool-id
- project_id: project_id
- provisioning_status: provisioning_status
- timeout: healthmonitor-timeout
- type: healthmonitor-type
- updated_at: updated_at
- url_path: healthmonitor-url_path
Response Example
----------------
.. literalinclude:: examples/healthmonitor-update-response.json
:language: javascript
Remove a Health Monitor
=======================
.. rest_method:: DELETE /v2.0/lbaas/healthmonitors/{healthmonitor_id}
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.
.. rest_status_code:: success ../http-status.yaml
- 204
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 409
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- healthmonitor_id: path-healthmonitor-id
Curl Example
------------
.. literalinclude:: examples/healthmonitor-delete-curl
:language: bash
Response
--------
There is no body content for the response of a successful DELETE request.

5
api-ref/source/v2/index.rst
View File

@ -30,3 +30,8 @@ Pools
Members
-------
.. include:: member.inc
--------------
Health Monitor
--------------
.. include:: healthmonitor.inc

13
api-ref/source/v2/listener.inc
View File

@ -1,6 +1,6 @@
.. -*- rst -*-
List listeners
List Listeners
==============
.. rest_method:: GET /v2.0/lbaas/listeners
@ -63,6 +63,7 @@ Response Parameters
- protocol_port: protocol_port
- provisioning_status: provisioning_status
- sni_container_refs: sni_container_refs
- updated_at: updated_at
Response Example
----------------
@ -143,6 +144,7 @@ Request
- protocol: protocol
- protocol_port: protocol_port
- sni_container_refs: sni_container_refs-optional
- updated_at: updated_at
.. _header_insertions:
@ -204,6 +206,7 @@ Response Parameters
- protocol_port: protocol_port
- provisioning_status: provisioning_status
- sni_container_refs: sni_container_refs
- updated_at: updated_at
Response Example
----------------
@ -272,6 +275,7 @@ Response Parameters
- protocol_port: protocol_port
- provisioning_status: provisioning_status
- sni_container_refs: sni_container_refs
- updated_at: updated_at
Response Example
----------------
@ -279,7 +283,7 @@ Response Example
.. literalinclude:: examples/listener-show-response.json
:language: javascript
Update a listener
Update a Listener
=================
.. rest_method:: PUT /v2.0/lbaas/listeners/{listener_id}
@ -357,6 +361,7 @@ Response Parameters
- protocol_port: protocol_port
- provisioning_status: provisioning_status
- sni_container_refs: sni_container_refs
- updated_at: updated_at
Response Example
----------------
@ -364,7 +369,7 @@ Response Example
.. literalinclude:: examples/listener-update-response.json
:language: javascript
Remove a listener
Remove a Listener
=================
.. rest_method:: DELETE /v2.0/lbaas/listeners/{listener_id}
@ -405,7 +410,7 @@ Response
There is no body content for the response of a successful DELETE request.
Get listener statistics
Get Listener statistics
=======================
.. rest_method:: GET /v2.0/lbaas/listeners/{listener_id}/stats

18
api-ref/source/v2/loadbalancer.inc
View File

@ -1,6 +1,6 @@
.. -*- rst -*-
List load balancers
List Load Balancers
===================
.. rest_method:: GET /v2.0/lbaas/loadbalancers
@ -58,6 +58,7 @@ Response Parameters
- project_id: project_id
- provider: provider
- provisioning_status: provisioning_status
- updated_at: updated_at
- vip_address: vip_address
- vip_network_id: vip_network_id
- vip_port_id: vip_port_id
@ -69,7 +70,7 @@ Response Example
.. literalinclude:: examples/loadbalancers-list-response.json
:language: javascript
Create a load balancer
Create a Load Balancer
======================
.. rest_method:: POST /v2.0/lbaas/loadbalancers
@ -184,6 +185,7 @@ Response Parameters
- project_id: project_id
- provider: provider
- provisioning_status: provisioning_status
- updated_at: updated_at
- vip_address: vip_address
- vip_network_id: vip_network_id
- vip_port_id: vip_port_id
@ -218,7 +220,7 @@ Response Example
.. literalinclude:: examples/loadbalancer-full-create-response.json
:language: javascript
Show load balancer details
Show Load Balancer details
==========================
.. rest_method:: GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}
@ -274,6 +276,7 @@ Response Parameters
- project_id: project_id
- provider: provider
- provisioning_status: provisioning_status
- updated_at: updated_at
- vip_address: vip_address
- vip_network_id: vip_network_id
- vip_port_id: vip_port_id
@ -285,7 +288,7 @@ Response Example
.. literalinclude:: examples/loadbalancer-show-response.json
:language: javascript
Update a load balancer
Update a Load Balancer
======================
.. rest_method:: PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}
@ -355,6 +358,7 @@ Response Parameters
- project_id: project_id
- provider: provider
- provisioning_status: provisioning_status
- updated_at: updated_at
- vip_address: vip_address
- vip_network_id: vip_network_id
- vip_port_id: vip_port_id
@ -366,7 +370,7 @@ Response Example
.. literalinclude:: examples/loadbalancer-update-response.json
:language: javascript
Remove a load balancer
Remove a Load Balancer
======================
.. rest_method:: DELETE /v2.0/lbaas/loadbalancers/{loadbalancer_id}
@ -411,7 +415,7 @@ Response
There is no body content for the response of a successful DELETE request.
Get load balancer statistics
Get Load Balancer statistics
============================
.. rest_method:: GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}/stats
@ -469,7 +473,7 @@ Response Example
.. literalinclude:: examples/loadbalancer-stats-response.json
:language: javascript
Get the load balancer status tree
Get the Load Balancer status tree
=================================
.. rest_method:: GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}/status

16
api-ref/source/v2/member.inc
View File

@ -1,6 +1,6 @@
.. -*- rst -*-
List members
List Members
============
.. rest_method:: GET /v2.0/lbaas/pools/{pool_id}/members
@ -49,7 +49,6 @@ Response Parameters
- address: address-member
- admin_state_up: admin_state_up
- created_at: created_at
- description: description
- id: member-id
- monitor_address: monitor_address
- monitor_port: monitor_port
@ -59,6 +58,7 @@ Response Parameters
- protocol_port: protocol_port-member
- provisioning_status: provisioning_status
- subnet_id: subnet_id
- updated_at: updated_at
- weight: weight
Response Example
@ -144,7 +144,6 @@ Request
- admin_state_up: admin_state_up-default-optional
- address: address
- description: description-optional
- monitor_address: monitor_address-optional
- monitor_port: monitor_port-optional
- name: name-optional
@ -174,7 +173,6 @@ Response Parameters
- address: address-member
- admin_state_up: admin_state_up
- created_at: created_at
- description: description
- id: member-id
- monitor_address: monitor_address
- monitor_port: monitor_port
@ -184,6 +182,7 @@ Response Parameters
- protocol_port: protocol_port-member
- provisioning_status: provisioning_status
- subnet_id: subnet_id
- updated_at: updated_at
- weight: weight
Response Example
@ -239,7 +238,6 @@ Response Parameters
- address: address-member
- admin_state_up: admin_state_up
- created_at: created_at
- description: description
- id: member-id
- monitor_address: monitor_address
- monitor_port: monitor_port
@ -249,6 +247,7 @@ Response Parameters
- protocol_port: protocol_port-member
- provisioning_status: provisioning_status
- subnet_id: subnet_id
- updated_at: updated_at
- weight: weight
Response Example
@ -257,7 +256,7 @@ Response Example
.. literalinclude:: examples/member-show-response.json
:language: javascript
Update a member
Update a Member
===============
.. rest_method:: PUT /v2.0/lbaas/pools/{pool_id}/members/{member_id}
@ -322,7 +321,6 @@ Response Parameters
- address: address-member
- admin_state_up: admin_state_up
- created_at: created_at
- description: description
- id: member-id
- monitor_address: monitor_address
- monitor_port: monitor_port
@ -332,6 +330,7 @@ Response Parameters
- protocol_port: protocol_port-member
- provisioning_status: provisioning_status
- subnet_id: subnet_id
- updated_at: updated_at
- weight: weight
Response Example
@ -340,7 +339,7 @@ Response Example
.. literalinclude:: examples/member-update-response.json
:language: javascript
Remove a member
Remove a Member
=================
.. rest_method:: DELETE /v2.0/lbaas/pools/{pool_id}/members/{member_id}
@ -381,4 +380,3 @@ Response
--------
There is no body content for the response of a successful DELETE request.

10
api-ref/source/v2/pool.inc
View File

@ -1,6 +1,6 @@
.. -*- rst -*-
List pools
List Pools
==========
.. rest_method:: GET /v2.0/lbaas/pools
@ -60,6 +60,7 @@ Response Parameters
- protocol: protocol-pools
- provisioning_status: provisioning_status
- session_persistence: session_persistence
- updated_at: updated_at
Response Example
----------------
@ -239,6 +240,7 @@ Response Parameters
- protocol: protocol-pools
- provisioning_status: provisioning_status
- session_persistence: session_persistence
- updated_at: updated_at
Response Example
----------------
@ -304,6 +306,7 @@ Response Parameters
- protocol: protocol-pools
- provisioning_status: provisioning_status
- session_persistence: session_persistence
- updated_at: updated_at
Response Example
----------------
@ -311,7 +314,7 @@ Response Example
.. literalinclude:: examples/pool-show-response.json
:language: javascript
Update a pool
Update a Pool
=============
.. rest_method:: PUT /v2.0/lbaas/pools/{pool_id}
@ -383,6 +386,7 @@ Response Parameters
- protocol: protocol-pools
- provisioning_status: provisioning_status
- session_persistence: session_persistence
- updated_at: updated_at
Response Example
----------------
@ -390,7 +394,7 @@ Response Example
.. literalinclude:: examples/pool-update-response.json
:language: javascript
Remove a pool
Remove a Pool
=============
.. rest_method:: DELETE /v2.0/lbaas/pools/{pool_id}