Merge "Fix API Doc LBaaS v2 When a Listener and pool are created the parameter protocol_port is optional according to the official documentation, but in reality it is required."
This commit is contained in:
Jenkins
@@ -489,12 +489,12 @@ At a minimum, you must specify these listener attributes:
|
||||
- ``protocol``. The protocol for which the front end listens. Must
|
||||
be ``HTTP``, ``HTTPS``, ``TCP``, or ``TERMINATED_HTTPS``.
|
||||
|
||||
Some attributes receive default values if you omit them from the
|
||||
request:
|
||||
|
||||
- ``protocol_port``. The port on which the front end listens. Must
|
||||
be an integer from 1 to 65535.
|
||||
|
||||
Some attributes receive default values if you omit them from the
|
||||
request:
|
||||
|
||||
- ``default_tls_container_ref``. The reference to a container that
|
||||
holds TLS secrets. If you also specify ``sni_container_refs``,
|
||||
this container is the default. This parameter is required for the
|
||||
@@ -776,8 +776,8 @@ Response Parameters
|
||||
- pools: pools-obj
|
||||
- admin_state_up: admin_state_up
|
||||
- description: description
|
||||
- health_monitors: health_monitors-response
|
||||
- health_monitors_status: health_monitors_status
|
||||
- healthmonitors: healthmonitors-response
|
||||
- healthmonitors_status: healthmonitors_status
|
||||
- id: pool-id-response
|
||||
- lb_algorithm: lb_algorithm
|
||||
- members: members
|
||||
@@ -886,8 +886,8 @@ Response Parameters
|
||||
- pool: pool
|
||||
- admin_state_up: admin_state_up
|
||||
- description: description
|
||||
- health_monitors: health_monitors-response
|
||||
- health_monitors_status: health_monitors_status
|
||||
- healthmonitors: healthmonitors-response
|
||||
- healthmonitors_status: healthmonitors_status
|
||||
- id: pool-id-response
|
||||
- lb_algorithm: lb_algorithm
|
||||
- members: members
|
||||
@@ -942,8 +942,8 @@ Response Parameters
|
||||
- pool: pool
|
||||
- admin_state_up: admin_state_up
|
||||
- description: description
|
||||
- health_monitors: health_monitors-response
|
||||
- health_monitors_status: health_monitors_status
|
||||
- healthmonitors: healthmonitors-response
|
||||
- healthmonitors_status: healthmonitors_status
|
||||
- lb_algorithm: lb_algorithm
|
||||
- members: members
|
||||
- id: pool-id-response
|
||||
@@ -975,7 +975,7 @@ validation of the request, the service returns the HTTP ``Accepted
|
||||
(202)`` response code.
|
||||
|
||||
Note: You cannot update the pool ID, ``project_id``,
|
||||
``listener_id``, ``listeners``, ``health_monitor_id``,
|
||||
``listener_id``, ``listeners``, ``healthmonitor_id``,
|
||||
``protocol``, and ``members`` immutable attributes. If you try to
|
||||
update any of these attributes, the service returns the HTTP
|
||||
``Immutable (422)`` response code .
|
||||
@@ -1013,8 +1013,8 @@ Response Parameters
|
||||
- pool: pool
|
||||
- admin_state_up: admin_state_up
|
||||
- description: description
|
||||
- health_monitors: health_monitors-response
|
||||
- health_monitors_status: health_monitors_status
|
||||
- healthmonitors: healthmonitors-response
|
||||
- healthmonitors_status: healthmonitors_status
|
||||
- id: pool-id-response
|
||||
- lb_algorithm: lb_algorithm
|
||||
- members: members
|
||||
@@ -1383,12 +1383,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitors: health_monitors-obj
|
||||
- healthmonitors: healthmonitors-obj
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes-response
|
||||
- http_method: http_method
|
||||
- id: health_monitor-id
|
||||
- id: healthmonitor-id
|
||||
- max_retries: max_retries
|
||||
- pools: pools
|
||||
- project_id: project_id
|
||||
@@ -1406,7 +1406,7 @@ Response Example
|
||||
Create health monitor
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2.0/lbaas/health_monitors
|
||||
.. rest_method:: POST /v2.0/lbaas/healthmonitors
|
||||
|
||||
Creates a health monitor.
|
||||
|
||||
@@ -1472,7 +1472,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor: health_monitor
|
||||
- healthmonitor: healthmonitor
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes
|
||||
@@ -1496,12 +1496,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor: health_monitor
|
||||
- healthmonitor: healthmonitor
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes-response
|
||||
- http_method: http_method
|
||||
- id: health_monitor-id
|
||||
- id: healthmonitor-id
|
||||
- max_retries: max_retries
|
||||
- pools: pools
|
||||
- project_id: project_id
|
||||
@@ -1519,7 +1519,7 @@ Response Example
|
||||
Show health monitor details
|
||||
===========================
|
||||
|
||||
.. rest_method:: GET /v2.0/lbaas/health_monitors/{health_monitor_id}
|
||||
.. rest_method:: GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}
|
||||
|
||||
Shows details for a health monitor.
|
||||
|
||||
@@ -1539,20 +1539,20 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor_id: health_monitor_id-path
|
||||
- healthmonitor_id: healthmonitor_id-path
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor: health_monitor
|
||||
- healthmonitor: healthmonitor
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes-response
|
||||
- http_method: http_method
|
||||
- max_retries: max_retries
|
||||
- id: health_monitor-id
|
||||
- id: healthmonitor-id
|
||||
- pools: pools
|
||||
- project_id: project_id
|
||||
- tenant_id: project_id
|
||||
@@ -1569,7 +1569,7 @@ Response Example
|
||||
Update health monitor
|
||||
=====================
|
||||
|
||||
.. rest_method:: PUT /v2.0/lbaas/health_monitors/{health_monitor_id}
|
||||
.. rest_method:: PUT /v2.0/lbaas/healthmonitors/{healthmonitor_id}
|
||||
|
||||
Updates a health monitor.
|
||||
|
||||
@@ -1590,8 +1590,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor_id: health_monitor_id-path
|
||||
- health_monitor: health_monitor
|
||||
- healthmonitor_id: healthmonitor_id-path
|
||||
- healthmonitor: healthmonitor
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes
|
||||
@@ -1611,13 +1611,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor: health_monitor
|
||||
- healthmonitor: healthmonitor
|
||||
- admin_state_up: admin_state_up
|
||||
- delay: delay
|
||||
- expected_codes: expected_codes-response
|
||||
- http_method: http_method
|
||||
- max_retries: max_retries
|
||||
- id: health_monitor-id
|
||||
- id: healthmonitor-id
|
||||
- pools: pools
|
||||
- project_id: project_id
|
||||
- tenant_id: project_id
|
||||
@@ -1634,7 +1634,7 @@ Response Example
|
||||
Remove health monitor
|
||||
=====================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/lbaas/health_monitors/{health_monitor_id}
|
||||
.. rest_method:: DELETE /v2.0/lbaas/healthmonitors/{healthmonitor_id}
|
||||
|
||||
Removes a health monitor and its associated configuration from the project.
|
||||
|
||||
@@ -1655,7 +1655,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- health_monitor_id: health_monitor_id-path
|
||||
- healthmonitor_id: healthmonitor_id-path
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@@ -103,6 +103,12 @@ health_monitor_id-path:
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
healthmonitor_id-path:
|
||||
description: |
|
||||
The ID for the health monitor.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
ikepolicy_id-path:
|
||||
description: |
|
||||
The ID of the IKE policy.
|
||||
@@ -2558,16 +2564,43 @@ health_monitors_status:
|
||||
type: string
|
||||
healthmonitor:
|
||||
description: |
|
||||
The associated healthmonitor, if any.
|
||||
A ``healthmonitor`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
healthmonitor_id:
|
||||
healthmonitor-id:
|
||||
description: |
|
||||
The UUID of the health monitor.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
healthmonitors-obj:
|
||||
description: |
|
||||
A list of ``healthmonitor`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
healthmonitors-request:
|
||||
description: |
|
||||
List of health monitors to be associated with the pool.
|
||||
The default is an empty list.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
healthmonitors-response:
|
||||
description: |
|
||||
List of health monitors that are associated with the pool.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
healthmonitors_status:
|
||||
description: |
|
||||
A list of ``healthmonitors_status`` objects,
|
||||
one per healthmonitor that contains a ``monitor_id``,
|
||||
``status`` and ``status_description``
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
http_method:
|
||||
description: |
|
||||
The HTTP method that the monitor uses for requests.
|
||||
@@ -4164,7 +4197,7 @@ protocol:
|
||||
The IP protocol. Valid value is ``icmp``,
|
||||
``tcp``, ``udp``, or ``null``. No default.
|
||||
in: body
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
protocol-response:
|
||||
description: |
|
||||
@@ -4212,7 +4245,7 @@ protocol_port-request:
|
||||
description: |
|
||||
The TCP or UDP port on which to listen.
|
||||
in: body
|
||||
required: false
|
||||
required: true
|
||||
type: integer
|
||||
provider:network_type:
|
||||
description: |
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"health_monitor": {}
|
||||
"healthmonitor": {}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"pool_id": "74aa2010-a59f-4d35-a436-60a6da882819",
|
||||
"admin_state_up": true,
|
||||
"delay": "1",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"admin_state_up": true,
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"admin_state_up": true,
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"admin_state_up": false,
|
||||
"delay": "2",
|
||||
"expected_codes": "200",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"admin_state_up": false,
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"health_monitors": [
|
||||
"healthmonitors": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
{
|
||||
"name": "pool1",
|
||||
"provisioning_status": "ACTIVE",
|
||||
"health_monitor": {
|
||||
"healthmonitor": {
|
||||
"type": "HTTP",
|
||||
"id": "90f7c765-0bc9-47c4-8513-4cc0c264c8f8",
|
||||
"provisioning_status": "ACTIVE"
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "simple pool",
|
||||
"health_monitors": [],
|
||||
"healthmonitors": [],
|
||||
"members": [],
|
||||
"status_description": null,
|
||||
"id": "af95e0ce-8a26-4f29-9524-db41e7769c73",
|
||||
@@ -14,7 +14,7 @@
|
||||
"subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d",
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [],
|
||||
"healthmonitors_status": [],
|
||||
"provider": "haproxy"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "",
|
||||
"health_monitors": [
|
||||
"healthmonitors": [
|
||||
"b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
],
|
||||
"members": [
|
||||
@@ -18,7 +18,7 @@
|
||||
"subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [
|
||||
"healthmonitors_status": [
|
||||
{
|
||||
"monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
|
||||
"status": "ACTIVE",
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "",
|
||||
"health_monitors": [
|
||||
"healthmonitors": [
|
||||
"b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
],
|
||||
"members": [
|
||||
@@ -18,7 +18,7 @@
|
||||
"subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [
|
||||
"healthmonitors_status": [
|
||||
{
|
||||
"monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
|
||||
"status": "ACTIVE",
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "",
|
||||
"health_monitors": [
|
||||
"healthmonitors": [
|
||||
"b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
],
|
||||
"members": [
|
||||
@@ -19,7 +19,7 @@
|
||||
"subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
|
||||
"project_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [
|
||||
"healthmonitors_status": [
|
||||
{
|
||||
"monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
|
||||
"status": "ACTIVE",
|
||||
|
||||
Reference in New Issue
Block a user