From 0132d31b25b99eba67897316ea90c19811314e91 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Mon, 23 Jan 2017 06:13:40 +0000 Subject: [PATCH] api-ref: Fix LBaaS v1 API reference LBaaS v1 support was removed in Newton release, but there are still users of LBaaS v1 API. It looks reasonable to maintain it with minimum effort rather than dropping it. This commit fixes LBaaS v1 API document with rough checks. Note that project_id field is not listed in LBaaS v1 API intentionally as project_id field was added in Newton release. Part of blueprint neutron-in-tree-api-ref Change-Id: I82d8f00f726247eb305a6b7207ae1bd2262fe296 --- api-ref/source/v2/index.rst | 2 +- api-ref/source/v2/lbaas-v1.inc | 633 ++++++++++-------- api-ref/source/v2/lbaas-v2.inc | 12 +- api-ref/source/v2/parameters.yaml | 317 +++++---- .../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 + 30 files changed, 930 insertions(+), 431 deletions(-) create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/member-create-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/member-create-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/member-show-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/member-update-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/member-update-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/members-list-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-create-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-create-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-show-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-update-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pool-update-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/pools-list-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-create-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-create-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-show-response.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-update-request.json create mode 100644 api-ref/source/v2/samples/lbaas-v1/vip-update-response.json create 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 1321bc74a..f65da2185 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -56,5 +56,5 @@ Quality of Service ########################## Load Balancer as a Service ########################## -.. include:: lbaas-v1.inc .. include:: lbaas-v2.inc +.. include:: lbaas-v1.inc diff --git a/api-ref/source/v2/lbaas-v1.inc b/api-ref/source/v2/lbaas-v1.inc index 3b1756f82..197b2cf77 100644 --- a/api-ref/source/v2/lbaas-v1.inc +++ b/api-ref/source/v2/lbaas-v1.inc @@ -53,7 +53,8 @@ List pools Lists pools. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401 Request ------- @@ -63,28 +64,27 @@ Response Parameters .. rest_parameters:: parameters.yaml - - lb_algorithm: lb_algorithm - - status: pool-status - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id + - pools: pools-obj - admin_state_up: admin_state_up - - vip_id: vip_id + - description: description + - health_monitors: health_monitors-response - health_monitors_status: health_monitors_status + - id: pool-id-response + - lb_method: lb_method - members: members - - provider: provider - - pools: pools - - status_description: status_description - - id: id - 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/pools-list-response.json +.. literalinclude:: samples/lbaas-v1/pools-list-response.json :language: javascript Create a load balancer pool @@ -94,27 +94,30 @@ Create a load balancer pool Creates a load balancer pool. -Error response codes:201,400,401,413,503,500, +Normal response codes: 201 + +Error response codes: 400, 401 Request ------- .. rest_parameters:: parameters.yaml - - lb_method: lb_method - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - pool: pool - - name: name + - 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/pool-create-request.json +.. literalinclude:: samples/lbaas-v1/pool-create-request.json :language: javascript Response Parameters @@ -122,23 +125,28 @@ Response Parameters .. rest_parameters:: parameters.yaml - - lb_algorithm: lb_algorithm - - status: pool-status - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - admin_state_up: admin_state_up - - vip_id: vip_id - - health_monitors_status: health_monitors_status - - members: members - - provider: provider - - status_description: status_description - - id: id - 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 ================= @@ -148,42 +156,42 @@ Show pool details Shows details for a pool. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - pool_id: pool_id + - pool_id: pool_id-path Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - lb_algorithm: lb_algorithm - - status: pool-status - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - admin_state_up: admin_state_up - - vip_id: vip_id - - health_monitors_status: health_monitors_status - - members: members - - provider: provider - - status_description: status_description - - id: id - 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/pool-show-response.json +.. literalinclude:: samples/lbaas-v1/pool-show-response.json :language: javascript Update pool @@ -194,24 +202,26 @@ Update pool Updates a load balancer pool. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml + - pool_id: pool_id-path - pool: pool - - lb_method: lb_method - - description: description - - name: name - - admin_state_up: admin_state_up - - pool_id: pool_id + - 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/pool-update-request.json +.. literalinclude:: samples/lbaas-v1/pool-update-request.json :language: javascript Response Parameters @@ -219,28 +229,27 @@ Response Parameters .. rest_parameters:: parameters.yaml - - lb_algorithm: lb_algorithm - - status: pool-status - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - admin_state_up: admin_state_up - - vip_id: vip_id - - health_monitors_status: health_monitors_status - - members: members - - provider: provider - - status_description: status_description - - id: id - 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/pool-update-response.json +.. literalinclude:: samples/lbaas-v1/pool-update-response.json :language: javascript Delete pool @@ -250,14 +259,24 @@ Delete pool Deletes a load balancer pool. -Error response codes:204,400,401,413,503,500, +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 + - pool_id: pool_id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. .. ============================================================ @@ -271,7 +290,8 @@ Lists VIPs. The list might be empty. Normal response codes: 200 -Error response codes:500,401,503, + +Error response codes: 401 Request ------- @@ -281,28 +301,27 @@ 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 - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id + - subnet_id: vip-subnet_id - tenant_id: project_id - - project_id: project_id - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence - - address: address - - vips: vips - - protocol_port: protocol_port - - port_id: port_id - - id: id - - name: name Response Example ---------------- -.. literalinclude:: samples/lbaas/vips-list-response.json +.. literalinclude:: samples/lbaas-v1/vips-list-response.json :language: javascript Create a load balancer VIP @@ -312,31 +331,37 @@ Create a load balancer VIP Creates a load balancer VIP. -Error response codes:201,400,404,500,401,413,503,409, +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 - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence - vip: vip - - address: address + - 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 - - name: name + - session_persistence: vip-session_persistence-request + - subnet_id: vip-subnet_id + - tenant_id: project_id-request Request Example --------------- -.. literalinclude:: samples/lbaas/vip-create-request.json +.. literalinclude:: samples/lbaas-v1/vip-create-request.json :language: javascript Response Parameters @@ -344,23 +369,28 @@ 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 - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id + - subnet_id: vip-subnet_id - tenant_id: project_id - - project_id: project_id - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence - - vip: vip - - address: address - - protocol_port: protocol_port - - port_id: port_id - - id: id - - name: name + +Response Example +---------------- + +.. literalinclude:: samples/lbaas-v1/vip-create-response.json + :language: javascript Show VIP details ================ @@ -370,42 +400,42 @@ Show VIP details Shows details for a VIP. Normal response codes: 200 -Error response codes:404,403,500,401,413,503,409, + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - vip_id: vip_id + - 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 - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id + - subnet_id: vip-subnet_id - tenant_id: project_id - - project_id: project_id - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence - - vip: vip - - address: address - - protocol_port: protocol_port - - port_id: port_id - - id: id - - name: name Response Example ---------------- -.. literalinclude:: samples/lbaas/vip-show-response.json +.. literalinclude:: samples/lbaas-v1/vip-show-response.json :language: javascript Update VIP @@ -416,26 +446,27 @@ Update VIP Updates a load balancer VIP. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - description: description - - admin_state_up: admin_state_up - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence + - vip_id: vip_id-path - vip: vip - - name: name - - vip_id: vip_id + - 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/vip-update-request.json +.. literalinclude:: samples/lbaas-v1/vip-update-request.json :language: javascript Response Parameters @@ -443,28 +474,27 @@ 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 - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id + - subnet_id: vip-subnet_id - tenant_id: project_id - - project_id: project_id - - connection_limit: connection_limit - - pool_id: pool_id - - session_persistence: session_persistence - - vip: vip - - address: address - - protocol_port: protocol_port - - port_id: port_id - - id: id - - name: name Response Example ---------------- -.. literalinclude:: samples/lbaas/vip-update-response.json +.. literalinclude:: samples/lbaas-v1/vip-update-response.json :language: javascript Delete VIP @@ -474,14 +504,21 @@ Delete VIP Deletes a load balancer VIP. -Error response codes:204,400,401,413,503,500, +Normal response codes: 204 + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - vip_id: vip_id + - vip_id: vip_id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. .. ============================================================ @@ -493,7 +530,8 @@ List members Lists members. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401 Request ------- @@ -503,22 +541,21 @@ 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 - - weight: weight - - admin_state_up: admin_state_up - tenant_id: project_id - - project_id: project_id - - pool_id: pool_id - - members: members - - address: address - - protocol_port: protocol_port - - id: id + - weight: member-weight Response Example ---------------- -.. literalinclude:: samples/lbaas/members-list-response.json +.. literalinclude:: samples/lbaas-v1/members-list-response.json :language: javascript Create a load balancer member @@ -528,26 +565,27 @@ Create a load balancer member Creates a load balancer member. -Error response codes:201,400,401,413,503,500, +Normal response codes: 201 + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - weight: weight - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - pool_id: pool_id - 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/member-create-request.json +.. literalinclude:: samples/lbaas-v1/member-create-request.json :language: javascript Response Parameters @@ -555,17 +593,22 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: member-status - - status_description: status_description - - weight: weight - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - pool_id: pool_id - member: member - address: address + - admin_state_up: admin_state_up + - id: member-id-response + - pool_id: member-pool_id - protocol_port: protocol_port - - id: id + - 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 =================== @@ -575,36 +618,36 @@ Show member details Shows details for a member. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - member_id: member_id + - member_id: member_id-path Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: member-status - - status_description: status_description - - weight: weight - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - pool_id: pool_id - member: member - address: address + - admin_state_up: admin_state_up + - id: member-id-response + - pool_id: member-pool_id - protocol_port: protocol_port - - id: id + - status: member-status + - status_description: status_description + - tenant_id: project_id + - weight: member-weight Response Example ---------------- -.. literalinclude:: samples/lbaas/member-show-response.json +.. literalinclude:: samples/lbaas-v1/member-show-response.json :language: javascript Update member @@ -615,23 +658,24 @@ Update member Updates a load balancer member. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml + - member_id: member_id-path - member: member - - pool_id: pool_id - - weight: weight - - admin_state_up: admin_state_up - - member_id: member_id + - admin_state_up: admin_state_up-request + - pool_id: member-pool_id-request + - weight: member-weight-request Request Example --------------- -.. literalinclude:: samples/lbaas/member-update-request.json +.. literalinclude:: samples/lbaas-v1/member-update-request.json :language: javascript Response Parameters @@ -639,22 +683,21 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: member-status - - status_description: status_description - - weight: weight - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - pool_id: pool_id - member: member - address: address + - admin_state_up: admin_state_up + - id: member-id-response + - pool_id: member-pool_id - protocol_port: protocol_port - - id: id + - status: member-status + - status_description: status_description + - tenant_id: project_id + - weight: member-weight Response Example ---------------- -.. literalinclude:: samples/lbaas/member-update-response.json +.. literalinclude:: samples/lbaas-v1/member-update-response.json :language: javascript Delete member @@ -664,14 +707,21 @@ Delete member Deletes a load balancer member. -Error response codes:204,400,401,413,503,500, +Normal response codes: 204 + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - member_id: member_id + - member_id: member_id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. .. ============================================================ @@ -683,7 +733,8 @@ List health monitors Lists health monitors. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401 Request ------- @@ -693,24 +744,23 @@ Response Parameters .. rest_parameters:: parameters.yaml - - health_monitors: health_monitors - - tenant_id: project_id - - project_id: project_id + - health_monitors: health_monitors-obj - admin_state_up: admin_state_up - delay: delay - - expected_codes: expected_codes - - max_retries: max_retries + - expected_codes: expected_codes-response - http_method: http_method - - timeout: timeout + - id: health_monitor-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- -.. literalinclude:: samples/lbaas/healthmonitors-list-response.json +.. literalinclude:: samples/lbaas-v1/healthmonitors-list-response.json :language: javascript Create a load balancer health monitor @@ -720,7 +770,9 @@ Create a load balancer health monitor Creates a load balancer health monitor. -Error response codes:201,400,401,413,503,500, +Normal response codes: 201 + +Error response codes: 400, 401 Request ------- @@ -728,21 +780,20 @@ Request .. rest_parameters:: parameters.yaml - health_monitor: health_monitor - - tenant_id: project_id - - project_id: project_id - - admin_state_up: admin_state_up + - admin_state_up: admin_state_up-request - delay: delay - expected_codes: expected_codes + - http_method: http_method-request - max_retries: max_retries - - http_method: http_method + - tenant_id: project_id-request - timeout: timeout - - url_path: url_path - type: type + - url_path: url_path Request Example --------------- -.. literalinclude:: samples/lbaas/healthmonitor-create-request.json +.. literalinclude:: samples/lbaas-v1/healthmonitor-create-request.json :language: javascript Response Parameters @@ -751,18 +802,23 @@ Response Parameters .. rest_parameters:: parameters.yaml - health_monitor: health_monitor - - tenant_id: project_id - - project_id: project_id - admin_state_up: admin_state_up - delay: delay - - expected_codes: expected_codes - - max_retries: max_retries + - expected_codes: expected_codes-response - http_method: http_method - - timeout: timeout + - id: health_monitor-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response + +Response Example +---------------- + +.. literalinclude:: samples/lbaas-v1/healthmonitor-create-response.json + :language: javascript Show health monitor details =========================== @@ -772,14 +828,15 @@ Show health monitor details Shows details for a health monitor. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - health_monitor_id: health_monitor_id + - health_monitor_id: health_monitor_id-path Response Parameters ------------------- @@ -787,23 +844,22 @@ Response Parameters .. rest_parameters:: parameters.yaml - health_monitor: health_monitor - - tenant_id: project_id - - project_id: project_id - admin_state_up: admin_state_up - delay: delay - - expected_codes: expected_codes - - max_retries: max_retries + - expected_codes: expected_codes-response - http_method: http_method - - timeout: timeout + - id: health_monitor-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- -.. literalinclude:: samples/lbaas/healthmonitor-show-response.json +.. literalinclude:: samples/lbaas-v1/healthmonitor-show-response.json :language: javascript Update health monitor @@ -814,27 +870,28 @@ Update health monitor Updates a load balancer health monitor. Normal response codes: 200 -Error response codes:400,401,413,503,500, + +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 + - admin_state_up: admin_state_up-request - delay: delay - expected_codes: expected_codes + - http_method: http_method-request - max_retries: max_retries - - http_method: http_method - timeout: timeout - url_path: url_path - - health_monitor_id: health_monitor_id Request Example --------------- -.. literalinclude:: samples/lbaas/healthmonitor-update-request.json +.. literalinclude:: samples/lbaas-v1/healthmonitor-update-request.json :language: javascript Response Parameters @@ -843,23 +900,22 @@ Response Parameters .. rest_parameters:: parameters.yaml - health_monitor: health_monitor - - tenant_id: project_id - - project_id: project_id - admin_state_up: admin_state_up - delay: delay - - expected_codes: expected_codes - - max_retries: max_retries + - expected_codes: expected_codes-response - http_method: http_method - - timeout: timeout + - id: health_monitor-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- -.. literalinclude:: samples/lbaas/healthmonitor-update-response.json +.. literalinclude:: samples/lbaas-v1/healthmonitor-update-response.json :language: javascript Delete health monitor @@ -869,14 +925,21 @@ Delete health monitor Deletes a load balancer health monitor. -Error response codes:204,400,401,413,503,500, +Normal response codes: 204 + +Error response codes: 401, 404, 409 Request ------- .. rest_parameters:: parameters.yaml - - health_monitor_id: health_monitor_id + - 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 ================================== @@ -885,21 +948,23 @@ Associate health monitor with pool Associates a health monitor with a pool. -Error response codes:201,400,401,413,503,500, +Normal response codes: 201 + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - id: id + - pool_id: pool_id-path - health_monitor: health_monitor - - pool_id: pool_id + - id: health_monitor-id Request Example --------------- -.. literalinclude:: samples/lbaas/healthmonitor-associate-request.json +.. literalinclude:: samples/lbaas-v1/healthmonitor-associate-request.json :language: javascript Response Parameters @@ -909,6 +974,12 @@ Response Parameters - health_monitor: health_monitor +Response Example +---------------- + +.. literalinclude:: samples/lbaas-v1/healthmonitor-associate-response.json + :language: javascript + Disassociate health monitor from pool ===================================== @@ -916,13 +987,19 @@ Disassociate health monitor from pool Disassociates a health monitor from a pool. -Error response codes:204,400,401,413,503,500, +Normal response codes: 201 + +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - health_monitor_id: health_monitor_id - - pool_id: pool_id + - 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/lbaas-v2.inc b/api-ref/source/v2/lbaas-v2.inc index 7b01e9400..9e9a50365 100644 --- a/api-ref/source/v2/lbaas-v2.inc +++ b/api-ref/source/v2/lbaas-v2.inc @@ -1282,7 +1282,7 @@ Request - member_id: member_id-path - member: member - admin_state_up: admin_state_up - - weight: weight + - weight: member-weight-request Request Example --------------- @@ -1379,12 +1379,12 @@ Response Parameters .. rest_parameters:: parameters.yaml - - health_monitors: health_monitors + - health_monitors: health_monitors-obj - admin_state_up: admin_state_up - delay: delay - expected_codes: expected_codes-response - http_method: http_method - - id: health_monitors-id + - id: health_monitor-id - max_retries: max_retries - pools: pools - project_id: project_id @@ -1497,7 +1497,7 @@ Response Parameters - delay: delay - expected_codes: expected_codes-response - http_method: http_method - - id: health_monitors-id + - id: health_monitor-id - max_retries: max_retries - pools: pools - project_id: project_id @@ -1548,7 +1548,7 @@ Response Parameters - expected_codes: expected_codes-response - http_method: http_method - max_retries: max_retries - - id: health_monitors-id + - id: health_monitor-id - pools: pools - project_id: project_id - tenant_id: project_id @@ -1613,7 +1613,7 @@ Response Parameters - expected_codes: expected_codes-response - http_method: http_method - max_retries: max_retries - - id: health_monitors-id + - id: health_monitor-id - pools: pools - project_id: project_id - tenant_id: project_id diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index f46ab03db..ee338c6e0 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -73,12 +73,6 @@ floatingip-id-path: in: path required: true type: string -health_monitor_id: - description: | - The UUID for the health monitor. - in: path - required: false - type: string health_monitor_id-path: description: | The ID for the health monitor. @@ -109,12 +103,6 @@ loadbalancer-id-path: in: path required: true type: string -member_id: - description: | - The UUID for the member. - in: path - required: false - type: string member_id-path: description: | The ID for the member. @@ -151,12 +139,6 @@ policy_id: in: path required: false type: string -pool_id: - description: | - The UUID for the pool. - in: path - required: false - type: string pool_id-path: description: | The ID for the pool. @@ -259,11 +241,11 @@ trunk_id: in: path required: true type: string -vip_id_1: +vip_id-path: description: | - The UUID for the VIP. + The ID for the VIP. in: path - required: false + required: true type: string vpnservice_id-path: description: | @@ -322,20 +304,6 @@ address: in: body required: true type: string -address_1: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: false - type: string -address_2: - description: | - The IP address of the VIP. - format: ipv4 - in: body - required: true - type: string address_scope_id: description: | An address scope to assign to the subnet pool. @@ -1343,8 +1311,13 @@ 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. + 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 @@ -1352,8 +1325,13 @@ expected_codes-response: 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. + 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: true type: string @@ -2172,29 +2150,28 @@ health_monitor: in: body required: true type: object -health_monitors: - description: | - List of health monitors that are associated with - the pool. - in: body - required: true - type: array -health_monitors-id: +health_monitor-id: description: | The ID of the associated health monitor. in: body required: true type: string -health_monitors-response: +health_monitors-obj: description: | - List of health monitors that are associated with - the pool. + A list of ``health_monitor`` objects. in: body required: true type: array -health_monitors_1: +health_monitors-request: description: | - A list of ``health_monitor`` objects. + List of health monitors to be associated with the pool. + The default is an empty list. + in: body + required: false + type: array +health_monitors-response: + description: | + List of health monitors that are associated with the pool. in: body required: true type: array @@ -2219,8 +2196,14 @@ healthmonitor_id: type: string http_method: description: | - The HTTP method that the monitor uses for - requests. + The HTTP method that the monitor uses for requests. + in: body + required: true + type: string +http_method-request: + description: | + The HTTP method that the monitor uses for requests. + The default is ``GET``. in: body required: false type: string @@ -2552,6 +2535,17 @@ lb_method: in: body required: true type: string +lb_method-request-put: + description: | + The load-balancer algorithm, which is round-robin + (``ROUND_ROBIN``), least-connections (``LEAST_CONNECTIONS``), + source IP (``SOURCE_IP``), and so on, that is used to distribute + traffic to the pool members. This value, which must be supported, + is dependent on the load-balancer provider. The round-robin + algorithm must be supported. + in: body + required: false + type: string lifetime: description: | The lifetime of the security association. The @@ -2734,6 +2728,18 @@ member-id-response: in: body required: true type: string +member-pool_id: + description: | + The ID of the pool which the member belongs to. + in: body + required: true + type: string +member-pool_id-request: + description: | + The ID of the pool which the member belongs to. + in: body + required: false + type: string member-status: description: | The status of the member. Indicates whether the @@ -2745,19 +2751,33 @@ member-weight: description: | The weight of a member determines the portion of requests or connections it services compared to the other members - of the pool. A value of 0 means the member does not participate in + of the pool. For example, a member with a weight of 10 receives five + times as much traffic as a member with a weight of 2. + A value of 0 means the member does not participate in load- balancing but still accepts persistent connections. A valid value is from 0 to 256. in: body required: true type: integer +member-weight-request: + description: | + The weight of a member determines the portion of + requests or connections it services compared to the other members + of the pool. For example, a member with a weight of 10 receives five + times as much traffic as a member with a weight of 2. + A value of 0 means the member does not participate in + load- balancing but still accepts persistent connections. A valid + value is from 0 to 256. The default is 1. + in: body + required: false + type: integer members: description: | The list of members that belong to the pool. in: body required: true type: array -members_1: +members-obj: description: | A list of ``member`` objects. in: body @@ -3355,6 +3375,25 @@ pool-id-response: in: body required: true type: string +pool-protocol: + description: | + The protocol of the pool, which is ``TCP``, + ``HTTP``, or ``HTTPS``. + in: body + required: true + type: string +pool-provider: + description: | + The provider name of the load balancer pool. + in: body + required: true + type: string +pool-provider-request: + description: | + The provider name of the load balancer pool. + in: body + required: false + type: string pool-status: description: | The status of the pool. Indicates whether the @@ -3413,12 +3452,6 @@ port_id_1: in: body required: false type: string -port_id_2: - description: | - The UUID of the VIP port. - in: body - required: true - type: string port_id_4: description: | The UUID of the port. @@ -3584,13 +3617,6 @@ protocol_1: in: body required: true type: string -protocol_2: - description: | - The protocol of the pool, which is ``TCP``, - ``HTTP``, or ``HTTPS``. - in: body - required: true - type: string protocol_3: description: | The protocol that is matched by the security @@ -3606,13 +3632,6 @@ protocol_4: in: body required: true type: string -protocol_5: - description: | - The protocol of the virtual IP (VIP) address. A - valid value is ``TCP``, ``HTTP``, or ``HTTPS``. - in: body - required: true - type: string protocol_6: description: | The IP protocol. Value is ``icmp``, ``tcp``, @@ -3632,12 +3651,6 @@ protocol_port-request: in: body required: false type: integer -provider: - description: | - The name of the provider. - in: body - required: false - type: string provider:network_type: description: | The type of physical network that maps to this @@ -4322,49 +4335,6 @@ service_type_1: in: body required: true type: string -session_persistence: - description: | - The session persistence algorithm. This algorithm - is a dictionary with type and cookie_name keys. - in: body - required: false - type: object -session_persistence_1: - description: | - Session persistence parameters for the VIP. Omit - the ``session_persistence`` parameter to prevent session - persistence. When no session persistence is used, the - ``session_persistence`` parameter does not appear in the API - response. To clear session persistence for the VIP, set the - ``session_persistence`` parameter to ``null`` in a VIP update - request. - in: body - required: false - type: object -session_persistence_2: - description: | - Session persistence parameters for the VIP. Omit - the ``session_persistence`` parameter to prevent session - persistence. When no session persistence is used, the - ``session_persistence`` parameter does not appear in the API - response. To clear session persistence for the VIP, set the - ``session_persistence`` parameter to ``null`` in a VIP update - request. - in: body - required: true - type: object -session_persistence_3: - description: | - Session persistence parameters for the VIP. Omit - the ``session_persistence`` parameter to prevent session - persistence. When no session persistence is used, the - ``session_persistence`` parameter does not appear in the API - response. To clear session persistence for the VIP, set the - ``session_persistence`` parameter to ``null`` in a VIP update - request. - in: body - required: false - type: object shared: description: | Admin-only. Indicates whether this network is @@ -5199,7 +5169,7 @@ url_path: description: | The HTTP path of the request sent by the monitor to test the health of a member. A valid value is a string that - begins with a forward slash (/). + begins with a forward slash (``/``). in: body required: false type: string @@ -5207,7 +5177,7 @@ url_path-response: description: | The HTTP path of the request sent by the monitor to test the health of a member. Must be a string that begins with - a forward slash (/). + a forward slash (``/``). The default is ``/``. in: body required: true type: string @@ -5278,6 +5248,73 @@ vip: in: body required: true type: object +vip-address: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: true + type: string +vip-address-request: + description: | + The IP address of the VIP. + format: ipv4 + in: body + required: false + type: string +vip-id: + description: | + The ID of the virtual IP (VIP) address. + in: body + required: true + type: string +vip-pool_id: + description: | + The ID of the pool which the VIP belongs to. + in: body + required: true + type: string +vip-pool_id-request: + description: | + The ID of the pool which the VIP belongs to. + in: body + required: false + type: string +vip-port_id: + description: | + The ID of the VIP port. + in: body + required: true + type: string +vip-protocol: + description: | + The protocol of the virtual IP (VIP) address. A + valid value is ``TCP``, ``HTTP``, or ``HTTPS``. + in: body + required: true + type: string +vip-session_persistence: + description: | + Session persistence parameters for the VIP. Omit + the ``session_persistence`` parameter to prevent session + persistence. When no session persistence is used, the + ``session_persistence`` parameter does not appear in the API + response. + in: body + required: true + type: object +vip-session_persistence-request: + description: | + Session persistence parameters for the VIP. Omit + the ``session_persistence`` parameter to prevent session + persistence. When no session persistence is used, the + ``session_persistence`` parameter does not appear in the API + response. To clear session persistence for the VIP, set the + ``session_persistence`` parameter to ``null`` in a VIP update + request. The default is no session persistence. + in: body + required: false + type: object vip-status: description: | The status of the VIP. Indicates whether the VIP @@ -5285,6 +5322,13 @@ vip-status: in: body required: true type: string +vip-subnet_id: + description: | + The ID of the subnet on which to allocate the + virtual IP (VIP) address. + in: body + required: true + type: string vip_address: description: | The IP address of the VIP . @@ -5366,22 +5410,3 @@ vpnservices: in: body required: true type: array -weight: - description: | - A positive integer value that indicates the - relative portion of traffic that this member should receive from - the pool. For example, a member with a weight of 10 receives five - times as much traffic as a member with a weight of 2. - in: body - required: false - type: integer -weight_1: - description: | - The weight of a member determines the portion of - requests or connections it services compared to the other members - of the pool. A value of 0 means the member does not participate in - load- balancing but still accepts persistent connections. A valid - value is from 0 to 256. - in: body - required: false - type: integer 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 new file mode 100644 index 000000000..9fe528a80 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-request.json @@ -0,0 +1,5 @@ +{ + "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 new file mode 100644 index 000000000..b70e51138 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-associate-response.json @@ -0,0 +1,3 @@ +{ + "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 new file mode 100644 index 000000000..44c054f2f --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-request.json @@ -0,0 +1,13 @@ +{ + "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 new file mode 100644 index 000000000..707d39768 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-create-response.json @@ -0,0 +1,15 @@ +{ + "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 new file mode 100644 index 000000000..6beb497d1 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-show-response.json @@ -0,0 +1,21 @@ +{ + "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 new file mode 100644 index 000000000..1991e3e15 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-request.json @@ -0,0 +1,11 @@ +{ + "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 new file mode 100644 index 000000000..c3e5ee297 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitor-update-response.json @@ -0,0 +1,21 @@ +{ + "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 new file mode 100644 index 000000000..f846ac0ea --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/healthmonitors-list-response.json @@ -0,0 +1,23 @@ +{ + "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 new file mode 100644 index 000000000..660429bfe --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/member-create-request.json @@ -0,0 +1,9 @@ +{ + "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 new file mode 100644 index 000000000..35f7b8cd6 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/member-create-response.json @@ -0,0 +1,13 @@ +{ + "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 new file mode 100644 index 000000000..046904e64 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/member-show-response.json @@ -0,0 +1,13 @@ +{ + "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 new file mode 100644 index 000000000..b5bf2c877 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/member-update-request.json @@ -0,0 +1,5 @@ +{ + "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 new file mode 100644 index 000000000..2cf4daea8 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/member-update-response.json @@ -0,0 +1,13 @@ +{ + "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 new file mode 100644 index 000000000..b9318a551 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/members-list-response.json @@ -0,0 +1,15 @@ +{ + "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 new file mode 100644 index 000000000..dc5d38ac1 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pool-create-request.json @@ -0,0 +1,10 @@ +{ + "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 new file mode 100644 index 000000000..a4a30ddb6 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pool-create-response.json @@ -0,0 +1,19 @@ +{ + "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 new file mode 100644 index 000000000..7a79359f1 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pool-show-response.json @@ -0,0 +1,29 @@ +{ + "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 new file mode 100644 index 000000000..d523eeabb --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pool-update-request.json @@ -0,0 +1,5 @@ +{ + "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 new file mode 100644 index 000000000..012de86b8 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pool-update-response.json @@ -0,0 +1,30 @@ +{ + "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 new file mode 100644 index 000000000..389fecdf5 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/pools-list-response.json @@ -0,0 +1,31 @@ +{ + "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 new file mode 100644 index 000000000..d9fae8153 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vip-create-request.json @@ -0,0 +1,10 @@ +{ + "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 new file mode 100644 index 000000000..9870ecca9 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vip-create-response.json @@ -0,0 +1,19 @@ +{ + "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 new file mode 100644 index 000000000..66ace793f --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vip-show-response.json @@ -0,0 +1,19 @@ +{ + "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 new file mode 100644 index 000000000..a29693659 --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vip-update-request.json @@ -0,0 +1,5 @@ +{ + "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 new file mode 100644 index 000000000..38c1831ce --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vip-update-response.json @@ -0,0 +1,19 @@ +{ + "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 new file mode 100644 index 000000000..6c7e9ea1a --- /dev/null +++ b/api-ref/source/v2/samples/lbaas-v1/vips-list-response.json @@ -0,0 +1,21 @@ +{ + "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" + } + ] +}