From f34b325505534d8dc53997363c9b8110d532cd6c Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Wed, 26 Jul 2017 15:39:48 -0700 Subject: [PATCH] Removing LBaaS v1 API reference LBaaS v1 was last included in the mitaka release which is now EOL. This patch removes the API reference section for the LBaaS v1 API. Change-Id: Ic2c042671fe625c63a524038f6d629b8e223abb1 --- api-ref/source/v2/index.rst | 1 - api-ref/source/v2/lbaas-v1.inc | 1001 ----------------- .../healthmonitor-associate-request.json | 5 - .../healthmonitor-associate-response.json | 3 - .../healthmonitor-create-request.json | 13 - .../healthmonitor-create-response.json | 15 - .../lbaas-v1/healthmonitor-show-response.json | 21 - .../healthmonitor-update-request.json | 11 - .../healthmonitor-update-response.json | 21 - .../healthmonitors-list-response.json | 23 - .../lbaas-v1/member-create-request.json | 9 - .../lbaas-v1/member-create-response.json | 13 - .../lbaas-v1/member-show-response.json | 13 - .../lbaas-v1/member-update-request.json | 5 - .../lbaas-v1/member-update-response.json | 13 - .../lbaas-v1/members-list-response.json | 15 - .../samples/lbaas-v1/pool-create-request.json | 10 - .../lbaas-v1/pool-create-response.json | 19 - .../samples/lbaas-v1/pool-show-response.json | 29 - .../samples/lbaas-v1/pool-update-request.json | 5 - .../lbaas-v1/pool-update-response.json | 30 - .../samples/lbaas-v1/pools-list-response.json | 31 - .../samples/lbaas-v1/vip-create-request.json | 10 - .../samples/lbaas-v1/vip-create-response.json | 19 - .../samples/lbaas-v1/vip-show-response.json | 19 - .../samples/lbaas-v1/vip-update-request.json | 5 - .../samples/lbaas-v1/vip-update-response.json | 19 - .../samples/lbaas-v1/vips-list-response.json | 21 - 28 files changed, 1399 deletions(-) delete mode 100644 api-ref/source/v2/lbaas-v1.inc delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/member-create-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/member-create-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/member-show-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/member-update-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/member-update-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/members-list-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-create-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-create-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-show-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-update-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-update-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/pools-list-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-create-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-create-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-show-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-update-request.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-update-response.json delete mode 100644 api-ref/source/v2/samples/lbaas-v1/vips-list-response.json diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index 212344750..d375d6ae2 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -53,7 +53,6 @@ Quality of Service ########################## Load Balancer as a Service ########################## -.. include:: lbaas-v1.inc .. include:: lbaas-v2.inc ##################################### Logging Resource (networking-midonet) diff --git a/api-ref/source/v2/lbaas-v1.inc b/api-ref/source/v2/lbaas-v1.inc deleted file mode 100644 index dfd3d385b..000000000 --- a/api-ref/source/v2/lbaas-v1.inc +++ /dev/null @@ -1,1001 +0,0 @@ -.. -*- rst -*- - -====================== -LBaaS 1.0 (DEPRECATED) -====================== - -The Load-Balancer-as-a-Service (LBaaS) v1.0 extension pairs with -the Networking v2.0 API to enable OpenStack projects to manage load -balancers for their VMs. With this extension, you can load-balance -client traffic from one network to application services, such as -VMs, on the same network. - -Use this extension to create and manage virtual IP addresses -(VIPs), pools, members of a pool, health monitors, and view status -of a resource. - -.. note:: - - LBaaS 1.0 support was removed in Newton release. It's no longer available - in any installations starting from this release. - -**Load balancer statuses** - -+----------------+--------------------------------------------------------------------+ -| Status | Description | -+----------------+--------------------------------------------------------------------+ -| ACTIVE | The resource is ready and active. | -+----------------+--------------------------------------------------------------------+ -| PENDING_CREATE | The resource is being created. | -+----------------+--------------------------------------------------------------------+ -| PENDING_UPDATE | The resource is being updated. | -+----------------+--------------------------------------------------------------------+ -| PENDING_DELETE | The resource is pending deletion. | -+----------------+--------------------------------------------------------------------+ -| INACTIVE | The resource is not active. | -+----------------+--------------------------------------------------------------------+ -| ERROR | An object within the service is not working. The ``error_details`` | -| | attribute provides an explanation for the error, its cause, and | -| | possibly a solution. | -+----------------+--------------------------------------------------------------------+ - -.. ============================================================ - -List pools -========== - -.. rest_method:: GET /v2.0/lb/pools - -Lists pools. - -Normal response codes: 200 - -Error response codes: 401 - -Request -------- - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - pools: pools-obj - - admin_state_up: admin_state_up - - description: description - - health_monitors: health_monitors-response - - health_monitors_status: health_monitors_status - - id: pool-id-response - - lb_method: lb_method - - members: members - - name: name - - protocol: pool-protocol - - provider: pool-provider - - status: pool-status - - status_description: status_description - - subnet_id: pool-subnet_id - - tenant_id: project_id - - vip_id: vip_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/pools-list-response.json - :language: javascript - -Create a load balancer pool -=========================== - -.. rest_method:: POST /v2.0/lb/pools - -Creates a load balancer pool. - -Normal response codes: 201 - -Error response codes: 400, 401 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool: pool - - admin_state_up: admin_state_up-request - - description: description-request - - health_monitors: health_monitors-request - - lb_method: lb_method - - name: name-request - - protocol: pool-protocol - - provider: pool-provider-request - - subnet_id: pool-subnet_id - - tenant_id: project_id-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/pool-create-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - pool: pool - - admin_state_up: admin_state_up - - description: description - - health_monitors: health_monitors-response - - health_monitors_status: health_monitors_status - - id: pool-id-response - - lb_method: lb_method - - members: members - - name: name - - protocol: pool-protocol - - provider: pool-provider - - status: pool-status - - status_description: status_description - - subnet_id: pool-subnet_id - - tenant_id: project_id - - vip_id: vip_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/pool-create-response.json - :language: javascript - -Show pool details -================= - -.. rest_method:: GET /v2.0/lb/pools/{pool_id} - -Shows details for a pool. - -Normal response codes: 200 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool_id: pool_id-path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - pool: pool - - admin_state_up: admin_state_up - - description: description - - health_monitors: health_monitors-response - - health_monitors_status: health_monitors_status - - id: pool-id-response - - lb_method: lb_method - - members: members - - name: name - - protocol: pool-protocol - - provider: pool-provider - - status: pool-status - - status_description: status_description - - subnet_id: pool-subnet_id - - tenant_id: project_id - - vip_id: vip_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/pool-show-response.json - :language: javascript - -Update pool -=========== - -.. rest_method:: PUT /v2.0/lb/pools/{pool_id} - -Updates a load balancer pool. - -Normal response codes: 200 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool_id: pool_id-path - - pool: pool - - admin_state_up: admin_state_up-request - - description: description-request - - health_monitors: health_monitors-request - - lb_method: lb_method-request-put - - name: name-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/pool-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - pool: pool - - admin_state_up: admin_state_up - - description: description - - health_monitors: health_monitors-response - - health_monitors_status: health_monitors_status - - id: pool-id-response - - lb_method: lb_method - - members: members - - name: name - - protocol: pool-protocol - - provider: pool-provider - - status: pool-status - - status_description: status_description - - subnet_id: pool-subnet_id - - tenant_id: project_id - - vip_id: vip_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/pool-update-response.json - :language: javascript - -Delete pool -=========== - -.. rest_method:: DELETE /v2.0/lb/pools/{pool_id} - -Deletes a load balancer pool. - -Normal response codes: 204 - -Error response codes: 401, 404, 409 - -When a requested load balancer pool has a VIP, -``Conflict (409)`` is returned. - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool_id: pool_id-path - -Response --------- - -There is no body content for the response of a successful DELETE request. - -.. ============================================================ - -List VIPs -========= - -.. rest_method:: GET /v2.0/lb/vips - -Lists VIPs. - -The list might be empty. - -Normal response codes: 200 - -Error response codes: 401 - -Request -------- - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - vips: vips - - address: vip-address - - admin_state_up: admin_state_up - - connection_limit: connection_limit-response - - description: description - - id: vip-id - - name: name - - pool_id: vip-pool_id - - port_id: vip-port_id - - protocol: vip-protocol - - protocol_port: protocol_port - - session_persistence: vip-session_persistence - - status: vip-status - - status_description: status_description - - subnet_id: vip-subnet_id - - tenant_id: project_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/vips-list-response.json - :language: javascript - -Create a load balancer VIP -========================== - -.. rest_method:: POST /v2.0/lb/vips - -Creates a load balancer VIP. - -Normal response codes: 201 - -Error response codes: 400, 401, 404, 409 - -When a specified pool already has a VIP, ``Conflict (409)`` is -returned. -When a specified pool or a specified subnet is not found, -``Not Found (404)`` is returned. - -Request -------- - -.. rest_parameters:: parameters.yaml - - - vip: vip - - address: vip-address-request - - admin_state_up: admin_state_up-request - - connection_limit: connection_limit - - description: description-request - - name: name-request - - pool_id: vip-pool_id - - protocol: vip-protocol - - protocol_port: protocol_port - - session_persistence: vip-session_persistence-request - - subnet_id: vip-subnet_id - - tenant_id: project_id-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/vip-create-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - vip: vip - - address: vip-address - - admin_state_up: admin_state_up - - connection_limit: connection_limit-response - - description: description - - id: vip-id - - name: name - - pool_id: vip-pool_id - - port_id: vip-port_id - - protocol: vip-protocol - - protocol_port: protocol_port - - session_persistence: vip-session_persistence - - status: vip-status - - status_description: status_description - - subnet_id: vip-subnet_id - - tenant_id: project_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/vip-create-response.json - :language: javascript - -Show VIP details -================ - -.. rest_method:: GET /v2.0/lb/vips/{vip_id} - -Shows details for a VIP. - -Normal response codes: 200 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - vip_id: vip_id-path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - vip: vip - - address: vip-address - - admin_state_up: admin_state_up - - connection_limit: connection_limit-response - - description: description - - id: vip-id - - name: name - - pool_id: vip-pool_id - - port_id: vip-port_id - - protocol: vip-protocol - - protocol_port: protocol_port - - session_persistence: vip-session_persistence - - status: vip-status - - status_description: status_description - - subnet_id: vip-subnet_id - - tenant_id: project_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/vip-show-response.json - :language: javascript - -Update VIP -========== - -.. rest_method:: PUT /v2.0/lb/vips/{vip_id} - -Updates a load balancer VIP. - -Normal response codes: 200 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - vip_id: vip_id-path - - vip: vip - - admin_state_up: admin_state_up-request - - connection_limit: connection_limit - - description: description-request - - name: name-request - - pool_id: vip-pool_id-request - - session_persistence: vip-session_persistence-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/vip-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - vip: vip - - address: vip-address - - admin_state_up: admin_state_up - - connection_limit: connection_limit-response - - description: description - - id: vip-id - - name: name - - pool_id: vip-pool_id - - port_id: vip-port_id - - protocol: vip-protocol - - protocol_port: protocol_port - - session_persistence: vip-session_persistence - - status: vip-status - - status_description: status_description - - subnet_id: vip-subnet_id - - tenant_id: project_id - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/vip-update-response.json - :language: javascript - -Delete VIP -========== - -.. rest_method:: DELETE /v2.0/lb/vips/{vip_id} - -Deletes a load balancer VIP. - -Normal response codes: 204 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - vip_id: vip_id-path - -Response --------- - -There is no body content for the response of a successful DELETE request. - -.. ============================================================ - -List members -============ - -.. rest_method:: GET /v2.0/lb/members - -Lists members. - -Normal response codes: 200 - -Error response codes: 401 - -Request -------- - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - members: members-obj - - address: address - - admin_state_up: admin_state_up - - id: member-id-response - - pool_id: member-pool_id - - protocol_port: protocol_port - - status: member-status - - status_description: status_description - - tenant_id: project_id - - weight: member-weight - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/members-list-response.json - :language: javascript - -Create a load balancer member -============================= - -.. rest_method:: POST /v2.0/lb/members - -Creates a load balancer member. - -Normal response codes: 201 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - member: member - - address: address - - admin_state_up: admin_state_up-request - - pool_id: member-pool_id - - protocol_port: protocol_port - - tenant_id: project_id-request - - weight: member-weight-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/member-create-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - member: member - - address: address - - admin_state_up: admin_state_up - - id: member-id-response - - pool_id: member-pool_id - - protocol_port: protocol_port - - status: member-status - - status_description: status_description - - tenant_id: project_id - - weight: member-weight - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/member-create-response.json - :language: javascript - -Show member details -=================== - -.. rest_method:: GET /v2.0/lb/members/{member_id} - -Shows details for a member. - -Normal response codes: 200 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - member_id: member_id-path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - member: member - - address: address - - admin_state_up: admin_state_up - - id: member-id-response - - pool_id: member-pool_id - - protocol_port: protocol_port - - status: member-status - - status_description: status_description - - tenant_id: project_id - - weight: member-weight - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/member-show-response.json - :language: javascript - -Update member -============= - -.. rest_method:: PUT /v2.0/lb/members/{member_id} - -Updates a load balancer member. - -Normal response codes: 200 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - member_id: member_id-path - - member: member - - admin_state_up: admin_state_up-request - - pool_id: member-pool_id-request - - weight: member-weight-request - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/member-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - member: member - - address: address - - admin_state_up: admin_state_up - - id: member-id-response - - pool_id: member-pool_id - - protocol_port: protocol_port - - status: member-status - - status_description: status_description - - tenant_id: project_id - - weight: member-weight - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/member-update-response.json - :language: javascript - -Delete member -============= - -.. rest_method:: DELETE /v2.0/lb/members/{member_id} - -Deletes a load balancer member. - -Normal response codes: 204 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - member_id: member_id-path - -Response --------- - -There is no body content for the response of a successful DELETE request. - -.. ============================================================ - -List health monitors -==================== - -.. rest_method:: GET /v2.0/lb/health_monitors - -Lists health monitors. - -Normal response codes: 200 - -Error response codes: 401 - -Request -------- - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - health_monitors: health_monitors-obj - - admin_state_up: admin_state_up - - delay: delay - - expected_codes: expected_codes-response - - http_method: http_method - - id: health_monitor-id - - max_retries: max_retries - - pools: pools - - tenant_id: project_id - - timeout: timeout - - type: type - - url_path: url_path-response - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitors-list-response.json - :language: javascript - -Create a load balancer health monitor -===================================== - -.. rest_method:: POST /v2.0/lb/health_monitors - -Creates a load balancer health monitor. - -Normal response codes: 201 - -Error response codes: 400, 401 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - health_monitor: health_monitor - - admin_state_up: admin_state_up-request - - delay: delay - - expected_codes: expected_codes - - http_method: http_method-request - - max_retries: max_retries - - tenant_id: project_id-request - - timeout: timeout - - type: type - - url_path: url_path - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-create-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - health_monitor: health_monitor - - admin_state_up: admin_state_up - - delay: delay - - expected_codes: expected_codes-response - - http_method: http_method - - id: health_monitor-id - - max_retries: max_retries - - pools: pools - - tenant_id: project_id - - timeout: timeout - - type: type - - url_path: url_path-response - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-create-response.json - :language: javascript - -Show health monitor details -=========================== - -.. rest_method:: GET /v2.0/lb/health_monitors/{health_monitor_id} - -Shows details for a health monitor. - -Normal response codes: 200 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - health_monitor_id: health_monitor_id-path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - health_monitor: health_monitor - - admin_state_up: admin_state_up - - delay: delay - - expected_codes: expected_codes-response - - http_method: http_method - - id: health_monitor-id - - max_retries: max_retries - - pools: pools - - tenant_id: project_id - - timeout: timeout - - type: type - - url_path: url_path-response - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-show-response.json - :language: javascript - -Update health monitor -===================== - -.. rest_method:: PUT /v2.0/lb/health_monitors/{health_monitor_id} - -Updates a load balancer health monitor. - -Normal response codes: 200 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - health_monitor_id: health_monitor_id-path - - health_monitor: health_monitor - - admin_state_up: admin_state_up-request - - delay: delay - - expected_codes: expected_codes - - http_method: http_method-request - - max_retries: max_retries - - timeout: timeout - - url_path: url_path - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - health_monitor: health_monitor - - admin_state_up: admin_state_up - - delay: delay - - expected_codes: expected_codes-response - - http_method: http_method - - id: health_monitor-id - - max_retries: max_retries - - pools: pools - - tenant_id: project_id - - timeout: timeout - - type: type - - url_path: url_path-response - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-update-response.json - :language: javascript - -Delete health monitor -===================== - -.. rest_method:: DELETE /v2.0/lb/health_monitors/{health_monitor_id} - -Deletes a load balancer health monitor. - -Normal response codes: 204 - -Error response codes: 401, 404, 409 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - health_monitor_id: health_monitor_id-path - -Response --------- - -There is no body content for the response of a successful DELETE request. - -Associate health monitor with pool -================================== - -.. rest_method:: POST /v2.0/lb/pools/{pool_id}/health_monitors - -Associates a health monitor with a pool. - -Normal response codes: 201 - -Error response codes: 400, 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool_id: pool_id-path - - health_monitor: health_monitor - - id: health_monitor-id - -Request Example ---------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-associate-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - health_monitor: health_monitor - -Response Example ----------------- - -.. literalinclude:: samples/lbaas-v1/healthmonitor-associate-response.json - :language: javascript - -Disassociate health monitor from pool -===================================== - -.. rest_method:: DELETE /v2.0/lb/pools/{pool_id}/health_monitors/{health_monitor_id} - -Disassociates a health monitor from a pool. - -Normal response codes: 201 - -Error response codes: 401, 404 - -Request -------- - -.. rest_parameters:: parameters.yaml - - - pool_id: pool_id-path - - health_monitor_id: health_monitor_id-path - -Response --------- - -There is no body content for the response of a successful DELETE request. diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json deleted file mode 100644 index 9fe528a80..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "health_monitor": { - "id": "b624decf-d5d3-4c66-9a3d-f047e7786181" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json deleted file mode 100644 index b70e51138..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "health_monitor": {} -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json deleted file mode 100644 index 44c054f2f..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "health_monitor": { - "admin_state_up": true, - "delay": 1, - "expected_codes": "200,201,202", - "http_method": "GET", - "max_retries": 5, - "pool_id": "74aa2010-a59f-4d35-a436-60a6da882819", - "timeout": 1, - "type": "HTTP", - "url_path": "/index.html" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json deleted file mode 100644 index 707d39768..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "health_monitor": { - "admin_state_up": true, - "delay": 1, - "expected_codes": "200,201,202", - "http_method": "GET", - "id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "max_retries": 5, - "pools": [], - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "timeout": 1, - "type": "HTTP", - "url_path": "/index.html" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json deleted file mode 100644 index 6beb497d1..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "health_monitor": { - "admin_state_up": true, - "delay": 1, - "expected_codes": "200,201,202", - "http_method": "GET", - "id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "max_retries": 5, - "pools": [ - { - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "status": "ACTIVE", - "status_description": null - } - ], - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "timeout": 1, - "type": "HTTP", - "url_path": "/index.html" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json deleted file mode 100644 index 1991e3e15..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "health_monitor": { - "admin_state_up": false, - "delay": 2, - "expected_codes": "200", - "http_method": "POST", - "max_retries": 2, - "timeout": 2, - "url_path": "/page.html" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json deleted file mode 100644 index c3e5ee297..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "health_monitor": { - "admin_state_up": false, - "delay": 2, - "expected_codes": "200", - "http_method": "POST", - "id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "max_retries": 2, - "pools": [ - { - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "status": "ACTIVE", - "status_description": null - } - ], - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "timeout": 2, - "type": "HTTP", - "url_path": "/page.html" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json b/api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json deleted file mode 100644 index f846ac0ea..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "health_monitors": [ - { - "admin_state_up": true, - "delay": 1, - "expected_codes": "200,201,202", - "http_method": "GET", - "id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "max_retries": 5, - "pools": [ - { - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "status": "ACTIVE", - "status_description": null - } - ], - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "timeout": 1, - "type": "HTTP", - "url_path": "/index.html" - } - ] -} diff --git a/api-ref/source/v2/samples/lbaas-v1/member-create-request.json b/api-ref/source/v2/samples/lbaas-v1/member-create-request.json deleted file mode 100644 index 660429bfe..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/member-create-request.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "member": { - "address": "10.0.0.22", - "admin_state_up": true, - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "protocol_port": 90, - "weight": 1 - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/member-create-response.json b/api-ref/source/v2/samples/lbaas-v1/member-create-response.json deleted file mode 100644 index 35f7b8cd6..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/member-create-response.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "member": { - "address": "10.0.0.22", - "admin_state_up": true, - "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "protocol_port": 90, - "status": "ACTIVE", - "status_description": null, - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "weight": 1 - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/member-show-response.json b/api-ref/source/v2/samples/lbaas-v1/member-show-response.json deleted file mode 100644 index 046904e64..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/member-show-response.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "member": { - "address": "10.0.1.22", - "admin_state_up": true, - "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "protocol_port": 90, - "status": "ACTIVE", - "status_description": null, - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "weight": 1 - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/member-update-request.json b/api-ref/source/v2/samples/lbaas-v1/member-update-request.json deleted file mode 100644 index b5bf2c877..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/member-update-request.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "member": { - "weight": 5 - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/member-update-response.json b/api-ref/source/v2/samples/lbaas-v1/member-update-response.json deleted file mode 100644 index 2cf4daea8..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/member-update-response.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "member": { - "address": "10.0.0.22", - "admin_state_up": true, - "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "protocol_port": 90, - "status": "ACTIVE", - "status_description": null, - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "weight": 5 - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/members-list-response.json b/api-ref/source/v2/samples/lbaas-v1/members-list-response.json deleted file mode 100644 index b9318a551..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/members-list-response.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "members": [ - { - "address": "10.0.1.22", - "admin_state_up": true, - "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "protocol_port": 90, - "status": "ACTIVE", - "status_description": null, - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "weight": 1 - } - ] -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pool-create-request.json b/api-ref/source/v2/samples/lbaas-v1/pool-create-request.json deleted file mode 100644 index dc5d38ac1..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pool-create-request.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "pool": { - "admin_state_up": true, - "description": "simple pool", - "lb_method": "ROUND_ROBIN", - "name": "my-pool", - "protocol": "HTTP", - "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pool-create-response.json b/api-ref/source/v2/samples/lbaas-v1/pool-create-response.json deleted file mode 100644 index a4a30ddb6..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pool-create-response.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "pool": { - "admin_state_up": true, - "description": "simple pool", - "health_monitors": [], - "health_monitors_status": [], - "id": "af95e0ce-8a26-4f29-9524-db41e7769c73", - "lb_method": "ROUND_ROBIN", - "members": [], - "name": "my-pool", - "protocol": "HTTP", - "provider": "haproxy", - "status": "PENDING_CREATE", - "status_description": null, - "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "vip_id": null - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pool-show-response.json b/api-ref/source/v2/samples/lbaas-v1/pool-show-response.json deleted file mode 100644 index 7a79359f1..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pool-show-response.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "pool": { - "admin_state_up": true, - "description": "", - "health_monitors": [ - "b7633ade-24dc-4d72-8475-06aa22be5412" - ], - "health_monitors_status": [ - { - "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "status": "ACTIVE", - "status_description": null - } - ], - "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "lb_method": "ROUND_ROBIN", - "members": [ - "cf024846-7516-4e3a-b0fb-6590322c836f" - ], - "name": "pool1", - "protocol": "HTTP", - "provider": "haproxy", - "status": "ACTIVE", - "status_description": null, - "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pool-update-request.json b/api-ref/source/v2/samples/lbaas-v1/pool-update-request.json deleted file mode 100644 index d523eeabb..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pool-update-request.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "pool": { - "name": "SuperPool" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pool-update-response.json b/api-ref/source/v2/samples/lbaas-v1/pool-update-response.json deleted file mode 100644 index 012de86b8..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pool-update-response.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "pool": { - "admin_state_up": true, - "description": "", - "health_monitors": [ - "b7633ade-24dc-4d72-8475-06aa22be5412" - ], - "health_monitors_status": [ - { - "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "status": "ACTIVE", - "status_description": null - } - ], - "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "lb_algorithm": "ROUND_ROBIN", - "members": [ - "cf024846-7516-4e3a-b0fb-6590322c836f" - ], - "name": "SuperPool", - "project_id": "eabfefa3fd1740a88a47ad98e132d238", - "protocol": "HTTP", - "provider": "haproxy", - "status": "PENDING_UPDATE", - "status_description": null, - "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/pools-list-response.json b/api-ref/source/v2/samples/lbaas-v1/pools-list-response.json deleted file mode 100644 index 389fecdf5..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/pools-list-response.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "pools": [ - { - "admin_state_up": true, - "description": "", - "health_monitors": [ - "b7633ade-24dc-4d72-8475-06aa22be5412" - ], - "health_monitors_status": [ - { - "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412", - "status": "ACTIVE", - "status_description": null - } - ], - "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "lb_method": "ROUND_ROBIN", - "members": [ - "cf024846-7516-4e3a-b0fb-6590322c836f" - ], - "name": "pool1", - "protocol": "HTTP", - "provider": "haproxy", - "status": "ACTIVE", - "status_description": null, - "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", - "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba" - } - ] -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vip-create-request.json b/api-ref/source/v2/samples/lbaas-v1/vip-create-request.json deleted file mode 100644 index d9fae8153..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vip-create-request.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "vip": { - "admin_state_up": true, - "name": "NewVip", - "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca", - "protocol": "HTTP", - "protocol_port": "80", - "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vip-create-response.json b/api-ref/source/v2/samples/lbaas-v1/vip-create-response.json deleted file mode 100644 index 9870ecca9..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vip-create-response.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "vip": { - "address": "10.0.0.4", - "admin_state_up": true, - "connection_limit": -1, - "description": "", - "id": "fa0373e0-9dd4-4ff7-98fc-8cceca9bdb4e", - "name": "NewVip", - "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca", - "port_id": "0ba4cd9c-edb4-4594-bac4-b68b49d5f04c", - "protocol": "HTTP", - "protocol_port": 80, - "session_persistence": null, - "status": "PENDING_CREATE", - "status_description": null, - "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272", - "tenant_id": "e68c3e65e1f34ee9b2357d0fe418a78b" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vip-show-response.json b/api-ref/source/v2/samples/lbaas-v1/vip-show-response.json deleted file mode 100644 index 66ace793f..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vip-show-response.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "vip": { - "address": "10.0.0.4", - "admin_state_up": true, - "connection_limit": -1, - "description": "", - "id": "388c739a-6a57-4e74-bc7b-a5cd60248bba", - "name": "my-Vip", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "port_id": "5328aeea-2988-41c0-b5fe-0fd0660979d3", - "protocol": "HTTP", - "protocol_port": 80, - "session_persistence": null, - "status": "ACTIVE", - "status_description": null, - "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vip-update-request.json b/api-ref/source/v2/samples/lbaas-v1/vip-update-request.json deleted file mode 100644 index a29693659..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vip-update-request.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "vip": { - "connection_limit": "1000" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vip-update-response.json b/api-ref/source/v2/samples/lbaas-v1/vip-update-response.json deleted file mode 100644 index 38c1831ce..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vip-update-response.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "vip": { - "address": "10.0.0.4", - "admin_state_up": true, - "connection_limit": 1000, - "description": "", - "id": "fa0373e0-9dd4-4ff7-98fc-8cceca9bdb4e", - "name": "NewVip", - "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca", - "port_id": "0ba4cd9c-edb4-4594-bac4-b68b49d5f04c", - "protocol": "HTTP", - "protocol_port": 80, - "session_persistence": null, - "status": "PENDING_UPDATE", - "status_description": null, - "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272", - "tenant_id": "e68c3e65e1f34ee9b2357d0fe418a78b" - } -} diff --git a/api-ref/source/v2/samples/lbaas-v1/vips-list-response.json b/api-ref/source/v2/samples/lbaas-v1/vips-list-response.json deleted file mode 100644 index 6c7e9ea1a..000000000 --- a/api-ref/source/v2/samples/lbaas-v1/vips-list-response.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "vips": [ - { - "address": "10.0.0.4", - "admin_state_up": true, - "connection_limit": -1, - "description": "", - "id": "388c739a-6a57-4e74-bc7b-a5cd60248bba", - "name": "my-Vip", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", - "port_id": "5328aeea-2988-41c0-b5fe-0fd0660979d3", - "protocol": "HTTP", - "protocol_port": 80, - "session_persistence": null, - "status": "ACTIVE", - "status_description": null, - "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", - "tenant_id": "eabfefa3fd1740a88a47ad98e132d238" - } - ] -}