octavia/api-ref/source/v2/amphora.inc

305 lines
6.1 KiB
ReStructuredText

.. -*- rst -*-
List Amphora
============
.. rest_method:: GET /v2/octavia/amphorae
Lists all amphora for the project.
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. Additionally, you can filter results
by using query string parameters. For information, see :ref:`filtering`.
The list might be empty.
.. NOTE::
The field `cached_zone` should be used for quick filtering and reference
only, as it may out of date. If an up-to-date zone is vital, we recommend
retrieving details directly from the compute service.
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- fields: fields
Curl Example
------------
.. literalinclude:: examples/amphora-list-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- id: amphora-id
- loadbalancer_id: loadbalancer-id
- compute_id: compute-id
- lb_network_ip: lb-network-ip
- vrrp_ip: vrrp-ip
- ha_ip: vip_address
- vrrp_port_id: vrrp-port-id
- ha_port_id: vip_port_id
- cert_expiration: cert-expiration
- cert_busy: cert-busy
- role: amphora-role
- status: amphora-status
- vrrp_interface: vrrp-interface
- vrrp_id: vrrp-id
- vrrp_priority: vrrp-priority
- cached_zone: cached-zone
- created_at: created_at
- updated_at: updated_at
- image_id: image-id
- compute_flavor: compute-flavor
Response Example
----------------
.. literalinclude:: examples/amphora-list-response.json
:language: javascript
Show Amphora details
====================
.. rest_method:: GET /v2/octavia/amphorae/{amphora_id}
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.
.. NOTE::
The field `cached_zone` should be used for quick filtering and reference
only, as it may out of date. If an up-to-date zone is vital, we recommend
retrieving details directly from the compute service.
.. 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
- amphora_id: path-amphora-id
Curl Example
------------
.. literalinclude:: examples/amphora-show-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- id: amphora-id
- loadbalancer_id: loadbalancer-id
- compute_id: compute-id
- lb_network_ip: lb-network-ip
- vrrp_ip: vrrp-ip
- ha_ip: vip_address
- vrrp_port_id: vrrp-port-id
- ha_port_id: vip_port_id
- cert_expiration: cert-expiration
- cert_busy: cert-busy
- role: amphora-role
- status: amphora-status
- vrrp_interface: vrrp-interface
- vrrp_id: vrrp-id
- vrrp_priority: vrrp-priority
- cached_zone: cached-zone
- created_at: created_at
- updated_at: updated_at
- image_id: image-id
- compute_flavor: compute-flavor
Response Example
----------------
.. literalinclude:: examples/amphora-show-response.json
:language: javascript
Show Amphora Statistics
=======================
.. rest_method:: GET /v2/octavia/amphorae/{amphora_id}/stats
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**
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- amphora_id: path-amphora-id
- fields: fields
Curl Example
------------
.. literalinclude:: examples/amphora-show-stats-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- active_connections: active_connections
- amphora_stats: amphora-stats
- bytes_in: bytes_in
- bytes_out: bytes_out
- id: amphora-id
- listener_id: listener-id
- loadbalancer_id: loadbalancer-id
- request_errors: request_errors
- total_connections: total_connections
Response Example
----------------
.. literalinclude:: examples/amphora-show-stats-response.json
:language: javascript
Configure Amphora
=================
.. rest_method:: PUT /v2/octavia/amphorae/{amphora_id}/config
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**
.. rest_status_code:: success ../http-status.yaml
- 202
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- amphora_id: path-amphora-id
Curl Example
------------
.. literalinclude:: examples/amphora-config-curl
:language: bash
Response
--------
There is no body content for the response of a successful PUT request.
Failover Amphora
================
.. rest_method:: PUT /v2/octavia/amphorae/{amphora_id}/failover
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.
.. rest_status_code:: success ../http-status.yaml
- 202
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- amphora_id: path-amphora-id
Curl Example
------------
.. literalinclude:: examples/amphora-failover-curl
:language: bash
Response
--------
There is no body content for the response of a successful PUT request.