diff --git a/api-ref/source/v2/lbaas-v2.inc b/api-ref/source/v2/lbaas-v2.inc index 662f51e41..79ad9b405 100644 --- a/api-ref/source/v2/lbaas-v2.inc +++ b/api-ref/source/v2/lbaas-v2.inc @@ -1,8 +1,4 @@ .. -*- rst -*- -.. needs:method_verification -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ================== LBaaS 2.0 (STABLE) @@ -10,7 +6,7 @@ LBaaS 2.0 (STABLE) The Load-Balancer-as-a-Service (LBaaS) version 2.0 extension pairs with the Networking 2.0 API to enable OpenStack projects to manage load balancers for -their VMs. With this extension you can load- balance client traffic from one +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 load balancers, listeners, pools, @@ -45,34 +41,44 @@ List load balancers Lists all load balancers for the project. +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see `Filtering +and Column Selection `__. + The list might be empty. Normal response codes: 200 -Error response codes: 404,500,401,503 +Error response codes: 401 Request ------- +.. rest_parameters:: parameters.yaml + + - fields: fields + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - description: description - - admin_state_up: admin_state_up - loadbalancers: loadbalancers - - tenant_id: project_id - - project_id: project_id - - provisioning_status: provisioning_status + - admin_state_up: admin_state_up + - description: description + - flavor: flavor-id-response + - id: loadbalancer-id - listeners: listeners - - vip_address: vip_address - - provider: provider - - vip_subnet_id: vip_subnet_id - - flavor: flavor - - id: id - - operating_status: operating_status - name: name + - operating_status: operating_status + - project_id: project_id + - provider: loadbalancer-provider + - provisioning_status: provisioning_status + - tenant_id: project_id + - vip_address: vip_address + - vip_subnet_id: vip_subnet_id Response Example ---------------- @@ -80,8 +86,8 @@ Response Example .. literalinclude:: samples/lbaas/loadbalancers-list-response.json :language: javascript -Create load balancer -==================== +Create a load balancer +====================== .. rest_method:: POST /v2.0/lbaas/loadbalancers @@ -134,19 +140,6 @@ request: - ``description``. Default is an empty string. -If the API cannot fulfill the request due to insufficient data or -data that is not valid, the service returns the HTTP ``Bad Request -(400)`` response code with information about the failure in the -response body. Validation errors require that you correct the error -and submit the request again. - -You can configure all documented features of the load balancer at -creation time by specifying the additional elements or attributes -in the request. - -Administrative users can specify a project ID that is different than -their own to create load balancers for other projects. - If you own the subnet where you want to create the load balancer VIP, you can specify a ``vip_address`` attribute. If you omit the ``vip_address`` attribute from the payload, the LBaaS service @@ -168,24 +161,25 @@ created on the given network using the default behavior. If assigned multiple fixed IPs, an IPv4 addresses is chosen as the VIP in preference to IPv6 addresses. -Example: Create a load balancer +Normal response codes: 201 -Error response codes: 201,404,409,401,413,503,500 +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - description: description - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id + - loadbalancer: loadbalancer + - admin_state_up: admin_state_up-request + - description: description-request + - flavor: flavor-id-request + - name: name-request + - project_id: project_id-request + - provider: loadbalancer-provider-request + - tenant_id: project_id-request - vip_address: vip_address - - provider: provider - vip_subnet_id: vip_subnet_id - - flavor: flavor - - name: name Request Example --------------- @@ -198,21 +192,27 @@ Response Parameters .. rest_parameters:: parameters.yaml - - description: description - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - provisioning_status: provisioning_status - - listeners: listeners - - vip_address: vip_address - - operating_status: operating_status - - provider: provider - - vip_subnet_id: vip_subnet_id - - flavor: flavor - - id: id - loadbalancer: loadbalancer + - admin_state_up: admin_state_up + - description: description + - flavor: flavor-id-response + - id: loadbalancer-id + - listeners: listeners - name: name + - operating_status: operating_status + - project_id: project_id + - provider: loadbalancer-provider + - provisioning_status: provisioning_status + - tenant_id: project_id + - vip_address: vip_address - vip_network_id: vip_network_id + - vip_subnet_id: vip_subnet_id + +Response Example +---------------- + +.. literalinclude:: samples/lbaas/loadbalancer-create-response.json + :language: javascript Show load balancer details ========================== @@ -228,30 +228,32 @@ belong to your project, the service returns the HTTP Normal response codes: 200 -Error response codes: 404,403,500,401,413,503,409 +Error response codes: 403, 401 Request ------- +.. rest_parameters:: parameters.yaml + + - loadbalancer_id: loadbalancer-id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - description: description + - loadbalancer: loadbalancer - admin_state_up: admin_state_up - - tenant_id: project_id + - description: description + - id: loadbalancer-id + - listeners: listeners + - name: name + - operating_status: operating_status - project_id: project_id - provisioning_status: provisioning_status - - listeners: listeners + - tenant_id: project_id - vip_address: vip_address - - operating_status: operating_status - - provider: provider - vip_subnet_id: vip_subnet_id - - flavor: flavor - - id: id - - loadbalancer: loadbalancer - - name: name Response Example ---------------- @@ -275,19 +277,20 @@ object for changes. This operation returns the updated load balancer object with the ``ACTIVE``, ``PENDING_UPDATE``, or ``ERROR`` provisioning status. -Normal response codes: 200 +Normal response codes: 202 -Error response codes: 400,401,413,503,500 +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - name: name - - description: description + - loadbalancer_id: loadbalancer-id-path - loadbalancer: loadbalancer - - admin_state_up: admin_state_up + - admin_state_up: admin_state_up-request + - name: name-request + - description: description-request Request Example --------------- @@ -300,20 +303,20 @@ Response Parameters .. rest_parameters:: parameters.yaml - - description: description - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - provisioning_status: provisioning_status - - listeners: listeners - - vip_address: vip_address - - operating_status: operating_status - - provider: provider - - vip_subnet_id: vip_subnet_id - - flavor: flavor - - id: id - loadbalancer: loadbalancer + - admin_state_up: admin_state_up + - description: description + - flavor: flavor-id-response + - id: loadbalancer-id + - listeners: listeners - name: name + - operating_status: operating_status + - project_id: project_id + - provider: loadbalancer-provider + - provisioning_status: provisioning_status + - tenant_id: project_id + - vip_address: vip_address + - vip_subnet_id: vip_subnet_id Response Example ---------------- @@ -333,11 +336,22 @@ cannot recover it. Example: Delete a load balancer -Error response codes: 204,400,401,413,503,500 +Normal response codes: 204 + +Error response codes: 401, 404 Request ------- +.. rest_parameters:: parameters.yaml + + - loadbalancer_id: loadbalancer-id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. + Show load balancer status tree ============================== @@ -356,23 +370,29 @@ statuses for its children. Normal response codes: 200 -Error response codes: 403,401,413,503,500 +Error response codes: 403, 401 Request ------- +.. rest_parameters:: parameters.yaml + + - loadbalancer_id: loadbalancer-id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - provisioning_status: provisioning_status + - statuses: statuses-response + - loadbalancer: loadbalancer - listeners: listeners - - healthmonitor: healthmonitor - - members: members - pools: pools - - id: id + - healthmonitor: healthmonitor + - id: loadbalancer-id + - members: members - operating_status: operating_status + - provisioning_status: provisioning_status Response Example ---------------- @@ -389,6 +409,12 @@ List listeners Lists all listeners. +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see `Filtering +and Column Selection `__. + This operation lists all listeners that are associated with your project. @@ -398,30 +424,34 @@ Example: List listeners Normal response codes: 200 -Error response codes: 500,401,503 +Error response codes: 401 Request ------- +.. rest_parameters:: parameters.yaml + + - fields: fields + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref + - listeners: listeners-response - admin_state_up: admin_state_up + - connection_limit: connection_limit-response + - default_pool_id: default_pool_id-response + - default_tls_container_ref: default_tls_container_ref-response + - description: description + - id: listener-id-response - loadbalancers: loadbalancers - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit - - listeners: listeners - - default_pool_id: default_pool_id - - id: id - name: name + - project_id: project_id + - protocol: protocol-response + - protocol_port: protocol_port + - sni_container_refs: sni_container_refs-response + - tenant_id: project_id Response Example ---------------- @@ -495,26 +525,28 @@ their own to create listeners for other projects. To update a listener, the load balancer to which to attach must have an ``ACTIVE`` provisioning status. -Error response codes: 201,404,409,401,413,503,500 +Normal response codes: 201 + +Error response codes: 400, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit - listener: listener + - admin_state_up: admin_state_up-request + - connection_limit: connection_limit - default_pool_id: default_pool_id - - loadbalancer_id: loadbalancer_id + - default_tls_container_ref: default_tls_container_ref + - description: description + - loadbalancer_id: loadbalancer-id - name: name + - project_id: project_id-request + - protocol: protocol-response + - protocol_port: protocol_port-request + - sni_container_refs: sni_container_refs + - tenant_id: project_id-request Request Example --------------- @@ -527,20 +559,26 @@ Response Parameters .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref - - admin_state_up: admin_state_up - - loadbalancers: loadbalancers - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit - listener: listener - - default_pool_id: default_pool_id - - id: id + - admin_state_up: admin_state_up + - connection_limit: connection_limit-response + - default_pool_id: default_pool_id-response + - default_tls_container_ref: default_tls_container_ref-response + - description: description + - id: listener-id-response + - loadbalancers: loadbalancers - name: name + - project_id: project_id + - protocol: protocol-response + - protocol_port: protocol_port + - sni_container_refs: sni_container_refs-response + - tenant_id: project_id + +Response Example +---------------- + +.. literalinclude:: samples/lbaas/listener-create-response.json + :language: javascript Show listener details ===================== @@ -558,30 +596,34 @@ Example: Show listener details Normal response codes: 200 -Error response codes: 404,403,500,401,413,503,409 +Error response codes: 401, 403 Request ------- +.. rest_parameters:: parameters.yaml + + - listener_id: listener-id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref - - admin_state_up: admin_state_up - - loadbalancers: loadbalancers - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit - listener: listener - - default_pool_id: default_pool_id - - id: id + - admin_state_up: admin_state_up + - connection_limit: connection_limit-response + - id: listener-id-response + - default_pool_id: default_pool_id-response + - default_tls_container_ref: default_tls_container_ref-response + - description: description + - loadbalancers: loadbalancers - name: name + - project_id: project_id + - protocol: protocol-response + - protocol_port: protocol_port + - sni_container_refs: sni_container_refs-response + - tenant_id: project_id Response Example ---------------- @@ -610,28 +652,23 @@ Note: You cannot update a listener if the load balancer to which the listener is attached does not have an ``ACTIVE`` provisioning status. -Normal response codes: 200 +Normal response codes: 202 -Error response codes: 400,401,413,503,500 +Error response codes: 422, 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref - - admin_state_up: admin_state_up - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit + - listener_id: listener-id-path - listener: listener - - default_pool_id: default_pool_id - - loadbalancer_id: loadbalancer_id + - admin_state_up: admin_state_up-request + - connection_limit: connection_limit + - default_tls_container_ref: default_tls_container_ref + - description: description - name: name + - sni_container_refs: sni_container_refs Request Example --------------- @@ -644,20 +681,20 @@ Response Parameters .. rest_parameters:: parameters.yaml - - protocol_port: protocol_port - - protocol: protocol - - description: description - - default_tls_container_ref: default_tls_container_ref - - admin_state_up: admin_state_up - - loadbalancers: loadbalancers - - tenant_id: project_id - - project_id: project_id - - sni_container_refs: sni_container_refs - - connection_limit: connection_limit - listener: listener - - default_pool_id: default_pool_id - - id: id + - admin_state_up: admin_state_up + - connection_limit: connection_limit-response + - default_pool_id: default_pool_id-response + - default_tls_container_ref: default_tls_container_ref-response + - description: description + - id: listener-id-response + - loadbalancers: loadbalancers - name: name + - project_id: project_id + - protocol: protocol-response + - protocol_port: protocol_port + - sni_container_refs: sni_container_refs-response + - tenant_id: project_id Response Example ---------------- @@ -681,11 +718,22 @@ attached does not have an ``ACTIVE`` provisioning status. Example: Delete a listener -Error response codes: 204,400,409,401,413,503,500 +Normal response codes: 204 + +Error response codes: 401, 404, 409 Request ------- +.. rest_parameters:: parameters.yaml + + - listener_id: listener-id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. + .. ============================================================ List pools @@ -695,36 +743,49 @@ List pools Lists all pools that are associated with your project. +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see `Filtering +and Column Selection `__. + The list might be empty. Example: List pools Normal response codes: 200 -Error response codes: 500,401,504 +Error response codes: 401 Request ------- +.. rest_parameters:: parameters.yaml + + - fields: fields + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status - - lb_method: lb_method - - 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_algorithm: lb_algorithm - members: members - - pools: pools - - id: id - name: name + - project_id: project_id + - protocol: protocol-response + - provider: loadbalancer-provider + - status: status + - status_description: status_description + - subnet_id: pool-subnet_id + - tenant_id: project_id + - vip_id: vip_id Response Example ---------------- @@ -757,7 +818,7 @@ At a minimum, you must specify these pool attributes: distributes traffic to the pool members. The load-balancer provider must support this algorithm. -- ``listener_id``. The UUID of the listener in which this pool +- ``listener_id``. The ID of the listener in which this pool becomes the default pool. Each listener has only one default pool. @@ -787,22 +848,25 @@ their own to create pools for other projects. To update a pool, the load balancer to which to attach must have an ``ACTIVE`` provisioning status. -Error response codes: 201,404,409,401,413,503,500 +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 - lb_algorithm: lb_algorithm - - protocol: protocol - - description: description - - admin_state_up: admin_state_up - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - listener_id: listener_id + - listener_id: listener-id-response - name: name + - project_id: project_id-request + - protocol: protocol + - subnet_id: pool-subnet_id + - tenant_id: project_id-request Request Example --------------- @@ -815,22 +879,29 @@ Response Parameters .. rest_parameters:: parameters.yaml - - lb_algorithm: lb_algorithm - - status: status - - protocol: protocol - - description: description - - vip_id: vip_id - - admin_state_up: admin_state_up - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - - session_persistence: session_persistence - - healthmonitor_id: healthmonitor_id - - health_monitors_status: health_monitors_status - - members: members - - 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_algorithm: lb_algorithm + - members: members - name: name + - project_id: project_id + - protocol: protocol-response + - provider: loadbalancer-provider + - status: status + - status_description: status_description + - subnet_id: pool-subnet_id + - tenant_id: project_id + - vip_id: vip_id + +Response Example +---------------- + +.. literalinclude:: samples/lbaas/pool-create-response.json + :language: javascript Show pool details ================= @@ -850,30 +921,37 @@ Example: Show pool details Normal response codes: 200 -Error response codes: 404,403,500,401,413,503,409 +Error response codes: 403 Request ------- +.. rest_parameters:: parameters.yaml + + - pool_id: pool_id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status - - lb_method: lb_method - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id + - pool: pool - admin_state_up: admin_state_up - - vip_id: vip_id + - description: description + - health_monitors: health_monitors-response + - health_monitors_status: health_monitors_status + - lb_algorithm: lb_algorithm - members: members - - pools: pools - - id: id + - id: pool-id-response - name: name + - status: status + - status_description: status_description + - project_id: project_id + - protocol: protocol-response + - provider: loadbalancer-provider + - subnet_id: pool-subnet_id + - tenant_id: project_id + - vip_id: vip_id Response Example ---------------- @@ -892,29 +970,30 @@ This operation updates the attributes of a pool. Upon successful validation of the request, the service returns the HTTP ``Accepted (202)`` response code. -Note: You cannot update the pool UUID, ``project_id``, +Note: You cannot update the pool ID, ``project_id``, ``listener_id``, ``listeners``, ``health_monitor_id``, ``protocol``, and ``members`` immutable attributes. If you try to update any of these attributes, the service returns the HTTP -``Immutable (422)`` response code. +``Immutable (422)`` response code . Note: You cannot update a pool if the load balancer to which it is attached does not have an ``ACTIVE`` provisioning status. -Normal response codes: 200 +Normal response codes: 202 -Error response codes: 400,401,413,503,500 +Error response codes: 422, 401, 404 Request ------- .. rest_parameters:: parameters.yaml + - pool_id: pool_id-path - pool: pool - - lb_method: lb_method - - description: description + - admin_state_up: admin_state_up-request + - description: description-request + - lb_algorithm: lb_algorithm - name: name - - admin_state_up: admin_state_up Request Example --------------- @@ -927,20 +1006,23 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status - - lb_method: lb_method - - protocol: protocol - - description: description - - health_monitors: health_monitors - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id + - pool: pool - 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_algorithm: lb_algorithm - members: members - - pools: pools - - id: id - name: name + - status: status + - status_description: status_description + - project_id: project_id + - protocol: protocol-response + - provider: loadbalancer-provider + - subnet_id: pool-subnet_id + - tenant_id: project_id + - vip_id: vip_id Response Example ---------------- @@ -962,11 +1044,22 @@ configuration data. You cannot recover it. You cannot delete a pool if the load balancer to which it is attached does not have an ``ACTIVE`` provisioning status. -Error response codes: 204,400,409,401,413,503,500 +Normal response codes: 204 + +Error response codes: 401, 404 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 pool members @@ -987,27 +1080,29 @@ Example: List pool members Normal response codes: 200 -Error response codes: 500,401,503 +Error response codes: 401, 404 Request ------- +.. rest_parameters:: parameters.yaml + + - pool_id: pool_id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: 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 + - admin_state_up: admin_state_up + - id: member-id-response + - project_id: project_id - protocol_port: protocol_port - - id: id + - subnet_id: pool-subnet_id + - tenant_id: project_id + - weight: member-weight Response Example ---------------- @@ -1062,19 +1157,22 @@ their own to create members for other projects. To update a member, the load balancer must have an ``ACTIVE`` provisioning status. -Error response codes: 201,404,409,401,413,503,500 +Normal response codes: 201 + +Error response codes: 400, 401 Request ------- .. rest_parameters:: parameters.yaml - - member: member - - subnet_id: subnet_id - - protocol_port: protocol_port - - tenant_id: project_id - - project_id: project_id + - pool_id: pool_id-path - address: address + - member: member + - project_id: project_id-request + - protocol_port: protocol_port + - subnet_id: pool-subnet_id-request + - tenant_id: project_id-request Request Example --------------- @@ -1087,16 +1185,21 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status - - weight: weight - - admin_state_up: admin_state_up - - subnet_id: subnet_id - - tenant_id: project_id - - project_id: project_id - member: member - address: address + - admin_state_up: admin_state_up + - id: member-id-response + - project_id: project_id - protocol_port: protocol_port - - id: id + - subnet_id: pool-subnet_id + - tenant_id: project_id + - weight: member-weight + +Response Example +---------------- + +.. literalinclude:: samples/lbaas/member-create-response.json + :language: javascript Show pool member details ======================== @@ -1117,27 +1220,30 @@ Example: Show pool member details Normal response codes: 200 -Error response codes: 404,403,500,401,413,503,409 +Error response codes: 403, 401 Request ------- +.. rest_parameters:: parameters.yaml + + - pool_id: pool_id-path + - member_id: member_id-path + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: 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 + - project_id: project_id - protocol_port: protocol_port - - id: id + - subnet_id: pool-subnet_id + - tenant_id: project_id + - weight: member-weight Response Example ---------------- @@ -1155,7 +1261,7 @@ Updates attributes for a pool member. Upon successful validation of the request, the service returns the HTTP ``OK (200)`` response code. -Note: You cannot update the member UUID, ``project_id``, +Note: You cannot update the member ID, ``project_id``, ``address``, ``protocol_port``, and ``subnet_id`` attributes. If you attempt to update any of these attributes, the service returns the HTTP ``Immutable (422)`` response code. @@ -1165,17 +1271,18 @@ not have an ``ACTIVE`` provisioning status. Normal response codes: 200 -Error response codes: 400,401,413,503,500 +Error response codes: 401, 404, 422 Request ------- .. rest_parameters:: parameters.yaml + - pool_id: pool_id-path + - member_id: member_id-path - member: member - - pool_id: pool_id - - weight: weight - admin_state_up: admin_state_up + - weight: weight Request Example --------------- @@ -1188,17 +1295,15 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: 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 + - project_id: project_id - protocol_port: protocol_port - - id: id + - subnet_id: pool-subnet_id + - tenant_id: project_id + - weight: member-weight Response Example ---------------- @@ -1221,50 +1326,72 @@ have an ``ACTIVE`` provisioning status. Example: Remove a member from a pool -Error response codes: 204,400,409,401,413,503,500 +Normal response codes: 204 + +Error response codes: 401, 404 Request ------- +.. rest_parameters:: parameters.yaml + + - pool_id: pool_id-path + - 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/lbaas/health_monitors +.. rest_method:: GET /v2.0/lbaas/healthmonitors Lists health monitors. This operation lists all health monitors that are associated with your project. +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see `Filtering +and Column Selection `__. + This operation returns a list, which might be empty. Normal response codes: 200 -Error response codes: 500,401,503 +Error response codes: 401 Request ------- +.. rest_parameters:: parameters.yaml + + - fields: fields + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - health_monitors: health_monitors - - 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_monitors-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - project_id: project_id + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- @@ -1332,7 +1459,9 @@ their own to create health monitors for other projects. To update a health monitor, the load balancer to which to attach must have an ``ACTIVE`` provisioning status. -Error response codes: 201,404,409,401,413,503,500 +Normal response codes: 201 + +Error response codes: 401, 404 Request ------- @@ -1340,16 +1469,17 @@ Request .. 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 - http_method: http_method + - max_retries: max_retries + - pool_id: pool_id-request + - project_id: project_id + - tenant_id: project_id - timeout: timeout - - url_path: url_path - type: type + - url_path: url_path Request Example --------------- @@ -1363,18 +1493,24 @@ 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_monitors-id + - max_retries: max_retries - pools: pools - - url_path: url_path + - project_id: project_id + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response + +Response Example +---------------- + +.. literalinclude:: samples/lbaas/healthmonitor-show-response.json + :language: javascript Show health monitor details =========================== @@ -1392,29 +1528,33 @@ Example: Show health monitor details Normal response codes: 200 -Error response codes: 404,403,500,401,413,503,409 +Error response codes: 403, 401 Request ------- +.. rest_parameters:: parameters.yaml + + - health_monitor_id: health_monitor_id-path + 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 + - max_retries: max_retries + - id: health_monitors-id - pools: pools - - url_path: url_path + - project_id: project_id + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- @@ -1432,26 +1572,27 @@ Updates a health monitor. Upon successful validation of the request, the service returns the HTTP ``Accepted (202)`` response code. -Note: The health monitor UUID, ``project_id``, ``pool_id``, and type +Note: The health monitor ID, ``project_id``, ``pool_id``, and type are immutable attributes and cannot be updated. If you specify an unsupported attribute, the service returns the HTTP ``Immutable (422)`` response code. -Normal response codes: 200 +Normal response codes: 202 -Error response codes: 400,401,413,503,500 +Error response codes: 401, 404, 422 Request ------- .. rest_parameters:: parameters.yaml + - health_monitor_id: health_monitor_id-path - health_monitor: health_monitor - admin_state_up: admin_state_up - delay: delay - expected_codes: expected_codes - - max_retries: max_retries - http_method: http_method + - max_retries: max_retries - timeout: timeout - url_path: url_path @@ -1467,18 +1608,18 @@ 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 + - max_retries: max_retries + - id: health_monitors-id - pools: pools - - url_path: url_path + - project_id: project_id + - tenant_id: project_id + - timeout: timeout - type: type - - id: id + - url_path: url_path-response Response Example ---------------- @@ -1501,7 +1642,18 @@ does not have an ``ACTIVE`` provisioning status. Example: Delete a health monitor -Error response codes: 204,400,409,401,413,503,500 +Normal response codes: 204 + +Error response codes: 401, 404 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. diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index a099e362e..a9345eea8 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -55,6 +55,12 @@ health_monitor_id: in: path required: false type: string +health_monitor_id-path: + description: | + The ID for the health monitor. + in: path + required: true + type: string ikepolicy_id_1: description: | The UUID of the IKE policy. @@ -67,12 +73,30 @@ ipsecpolicy_id_1: in: path required: false type: string +listener-id-path: + description: | + The ID of the listener. + in: path + required: true + type: string +loadbalancer-id-path: + description: | + The ID of the load balancer. + 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. + in: path + required: true + type: string network_id_1: description: | The UUID of the network. @@ -97,6 +121,18 @@ pool_id: in: path required: false type: string +pool_id-path: + description: | + The ID for the pool. + in: path + required: true + type: string +pool_id-request: + description: | + The ID for the pool. + in: path + required: truee + type: string port_id: description: | The UUID of the port. @@ -622,12 +658,13 @@ connection_limit: in: body required: false type: integer -connection_limit_1: +connection_limit-response: description: | The maximum number of connections allowed for the - VIP. Value is ``-1`` if the limit is not set. + VIP. Value is ``-1`` if the limit is not set. Default + is infinite. in: body - required: false + required: true type: integer connection_limit_2: description: | @@ -672,14 +709,14 @@ default: type: boolean default_pool_id: description: | - The UUID of default pool. Must have compatible + The ID of default pool. Must have compatible protocol with listener. in: body required: false type: string -default_pool_id_1: +default_pool_id-response: description: | - The UUID of default pool. Must have compatible + The ID of default pool. Must have compatible protocol with listener. in: body required: true @@ -743,7 +780,7 @@ default_tls_container_ref: in: body required: false type: string -default_tls_container_ref_1: +default_tls_container_ref-response: description: | A reference to a container of TLS secrets. in: body @@ -1284,12 +1321,14 @@ expected_codes: in: body required: false type: string -expected_codes_1: +expected_codes-response: description: | - Expected HTTP codes for a passing HTTP(S) - monitor. + The list of HTTP status codes expected in + response from the member to declare it healthy. Specify one of the + following values: - A single value, such as 200. - A list, such + as 200, 202. - A range, such as 200-204. in: body - required: false + required: true type: string extension: description: | @@ -1486,6 +1525,18 @@ flavor: in: body required: true type: object +flavor-id-request: + description: | + The ID of the flavor. + in: body + required: false + type: string +flavor-id-response: + description: | + The ID of the flavor. + in: body + required: true + type: string flavor_1: description: | The UUID of a flavor. @@ -1549,7 +1600,20 @@ health_monitors: List of health monitors that are associated with the pool. in: body - required: false + required: true + type: array +health_monitors-id: + description: | + The ID of the associated health monitor. + in: body + required: true + type: string +health_monitors-response: + description: | + List of health monitors that are associated with + the pool. + in: body + required: true type: array health_monitors_1: description: | @@ -1557,12 +1621,6 @@ health_monitors_1: in: body required: true type: array -health_monitors_2: - description: | - The UUID for the associated health monitor. - in: body - required: true - type: string health_monitors_status: description: | The statuses of the health monitors that are @@ -1619,12 +1677,6 @@ id_12: in: body required: true type: string -id_13: - description: | - The UUID for the load balancer. - in: body - required: true - type: string id_14: description: | The UUID for the member. @@ -1919,17 +1971,6 @@ lb_method: in: body required: true type: string -lb_method_1: - 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 @@ -1967,9 +2008,15 @@ listener: in: body required: true type: object +listener-id-response: + description: | + The ID of the listener. + in: body + required: true + type: string listener_id: description: | - The UUID of the listener. + The ID of the listener. in: body required: false type: string @@ -1979,9 +2026,9 @@ listeners: in: body required: true type: array -listeners_1: +listeners-response: description: | - A ``listeners`` object. + A list of ``listeners`` objects. in: body required: true type: array @@ -1991,12 +2038,24 @@ loadbalancer: in: body required: true type: object -loadbalancer_id: +loadbalancer-id: description: | - The UUID of the load balancer. + The ID of the load balancer. in: body required: true type: string +loadbalancer-provider: + description: | + Provider name of the load balancer service. + in: body + required: true + type: string +loadbalancer-provider-request: + description: | + Provider name of the load balancer service. + in: body + required: false + type: string loadbalancers: description: | A list of load balancer objects. @@ -2106,6 +2165,22 @@ member: in: body required: true type: object +member-id-response: + description: | + The ID of the member. + in: body + required: true + type: string +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 + load- balancing but still accepts persistent connections. A valid + value is from 0 to 256. + in: body + required: true + type: integer members: description: | The list of members that belong to the pool. @@ -2719,29 +2794,22 @@ pool: in: body required: true type: object -pool_id_1: +pool-id-response: description: | - The UUID of the pool to which the member belongs. + The ID of the pool. in: body required: true type: string -pool_id_2: +pool-subnet_id: description: | - The UUID of the pool with which the VIP is - associated. + The subnet on which the members of the pool will be located. in: body required: true type: string -pool_id_3: +pool-subnet_id-request: description: | - The UUID of the pool to which the member belongs. - in: body - required: false - type: string -pool_id_4: - description: | - The UUID of the pool with which the VIP is - associated. + If you omit this parameter, LBaaS uses the + ``vip_subnet_id`` parameter value for the subnet UUID. in: body required: false type: string @@ -2752,7 +2820,7 @@ pools: in: body required: true type: array -pools_1: +pools-obj: description: | A list of ``pool`` objects. in: body @@ -2915,7 +2983,7 @@ protocol: in: body required: false type: string -protocol_1: +protocol-response: description: | The protocol to load balance. A valid value is ``HTTP``, ``HTTPS``, ``TCP``, or ``TERMINATED_HTTPS``. @@ -2964,19 +3032,11 @@ protocol_port: in: body required: true type: integer -protocol_port_1: +protocol_port-request: description: | - The port where the application is hosted. + The TCP or UDP port on which to listen. in: body - required: true - type: integer -protocol_port_2: - description: | - The port on which to listen to client traffic - that is associated with the virtual IP (VIP) address. A valid - value is from 0 to 65535. - in: body - required: true + required: false type: integer provider: description: | @@ -3740,7 +3800,7 @@ sni_container_refs: in: body required: false type: array -sni_container_refs_1: +sni_container_refs-response: description: | A list of references to TLS secrets. in: body @@ -3851,6 +3911,12 @@ status_description: in: body required: true type: string +statuses-response: + description: | + List of load balancer statuses. + in: body + required: true + type: string sub_ports: description: | A list of ports associated with the trunk. @@ -4155,6 +4221,281 @@ tenant_id: in: body required: true type: string +tenant_id-request: + description: | + The ID of the tenant who owns the resource. + Only administrative users can specify a tenant ID other than their own. + You cannot change this value through authorization policies. + in: body + required: false + type: string +tenant_id_1: + description: | + The UUID of the tenant. + in: body + required: true + type: string +tenant_id_10: + description: | + The UUID of the tenant who owns the load + balancer. Only administrative users can specify a tenant UUID + other than their own. + in: body + required: true + type: string +tenant_id_11: + description: | + The UUID of the tenant who owns the member. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_12: + description: | + The UUID of the tenant who owns the member. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_13: + description: | + The tenant UUID for the metering label. + in: body + required: true + type: string +tenant_id_14: + description: | + The UUID of the tenant who owns the network. Only + administrative users can specify a tenant UUID other than their + own. You cannot change this value through authorization policies. + in: body + required: false + type: string +tenant_id_15: + description: | + The tenant UUID of QoS policy owner. Only + administrative users can specify a tenant UUID other than their + own. You cannot change this value through authorization policies. + in: body + required: false + type: string +tenant_id_16: + description: | + The UUID of the tenant who owns the pool. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_17: + description: | + The UUID of the tenant who owns the security + group rule. Only administrative users can specify a tenant UUID + other than their own. + in: body + required: true + type: string +tenant_id_18: + description: | + The UUID of the tenant who owns the security + group. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: false + type: string +tenant_id_19: + description: | + The UUID of the tenant who owns the subnet pool. + Only administrative users can specify a tenant UUID other than + their own. You cannot change this value through authorization + policies. + in: body + required: false + type: string +tenant_id_2: + description: | + The UUID of the tenant who owns the network. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_20: + description: | + The UUID of the tenant who owns the VIP. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_21: + description: | + Owner of the VPN endpoint group. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_22: + description: | + Owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: false + type: string +tenant_id_23: + description: | + The UUID of the tenant who owns the firewall + policy. + in: body + required: true + type: string +tenant_id_24: + description: | + The UUID of the tenant who owns the firewall + rule. + in: body + required: true + type: string +tenant_id_25: + description: | + The UUID of the tenant who owns the health + monitor. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: true + type: string +tenant_id_26: + description: | + The owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_27: + description: | + Owner of the VPN service. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_28: + description: | + The UUID of the tenant who owns the VIP. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_29: + description: | + The UUID of the tenant who owns the network. + in: body + required: true + type: string +tenant_id_3: + description: | + The owner of the firewall service. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_30: + description: | + The UUID of tenant or project. + in: body + required: true + type: string +tenant_id_31: + description: | + The UUID of the tenant who owns the QoS policy. + in: body + required: true + type: string +tenant_id_32: + description: | + The UUID of the tenant who owns the pool. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_34: + description: | + The UUID of the tenant who owns the subnet pool. + in: body + required: true + type: string +tenant_id_35: + description: | + The UUID of the tenant. + in: body + required: true + type: string +tenant_id_36: + description: | + The owner of the firewall policy. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: false + type: string +tenant_id_37: + description: | + The UUID of the tenant who owns the firewall + rule. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: true + type: string +tenant_id_4: + description: | + The UUID of the tenant. Only administrative users + can specify a tenant UUID other than their own. + in: body + required: false + type: string +tenant_id_5: + description: | + The UUID of the tenant who owns the health + monitor. Only administrative users can specify a tenant UUID other + than their own. + in: body + required: false + type: string +tenant_id_6: + description: | + The owner of the IKE policy. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_7: + description: | + Owner of the IPSec policy. Only administrative + users can specify a tenant UUID other than their own. + in: body + required: true + type: string +tenant_id_8: + description: | + Owner of the IPSec connection. Only + administrative users can specify a tenant UUID other than their + own. + in: body + required: true + type: string +tenant_id_9: + description: | + The UUID of the tenant who owns the listener. + Only administrative users can specify a tenant UUID other than + their own. + in: body + required: true + type: string timeout: description: | The maximum time, in seconds, that a monitor @@ -4313,15 +4654,7 @@ url_path: in: body required: false type: string -url_path_1: - description: | - The HTTP path of the request sent by the monitor - to test the health of a member. A string value that must begin - with the forward slash (/). - in: body - required: false - type: string -url_path_2: +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 @@ -4398,21 +4731,21 @@ vip: type: object vip_address: description: | - The IP address of the VIP. - format: ipv4 - in: body - required: false - type: string -vip_address_1: - description: | - The IP address of the VIP. + 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 UUID of the virtual IP (VIP) address. + The ID of the virtual IP (VIP) address. in: body required: true type: string @@ -4482,13 +4815,3 @@ weight_1: in: body required: false type: integer -weight_2: - 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: true - type: integer diff --git a/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json b/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json index 859efa2da..71fc4231d 100644 --- a/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json +++ b/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json @@ -1,5 +1,6 @@ { "health_monitor": { + "pool_id": "74aa2010-a59f-4d35-a436-60a6da882819", "admin_state_up": true, "delay": "1", "expected_codes": "200,201,202", diff --git a/api-ref/source/v2/samples/lbaas/loadbalancer-update-response.json b/api-ref/source/v2/samples/lbaas/loadbalancer-update-response.json index 04a1d9a1e..72673b2dc 100644 --- a/api-ref/source/v2/samples/lbaas/loadbalancer-update-response.json +++ b/api-ref/source/v2/samples/lbaas/loadbalancer-update-response.json @@ -11,5 +11,7 @@ "tenant_id": "b7c1a69e88bf4b21a8148f787aef2081", "vip_address": "10.0.0.4", "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2" + "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", + "provider": "sample_provider" } } diff --git a/api-ref/source/v2/samples/lbaas/loadbalancers-list-response.json b/api-ref/source/v2/samples/lbaas/loadbalancers-list-response.json index 96ecb42c7..6359abbe3 100644 --- a/api-ref/source/v2/samples/lbaas/loadbalancers-list-response.json +++ b/api-ref/source/v2/samples/lbaas/loadbalancers-list-response.json @@ -12,6 +12,8 @@ "id": "a9729389-6147-41a3-ab22-a24aed8692b2", "operating_status": "ONLINE", "name": "loadbalancer1" + "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04" + "provider": "sample-provider" } ] } diff --git a/api-ref/source/v2/samples/lbaas/member-create-response.json b/api-ref/source/v2/samples/lbaas/member-create-response.json index b8655db11..3866459bd 100644 --- a/api-ref/source/v2/samples/lbaas/member-create-response.json +++ b/api-ref/source/v2/samples/lbaas/member-create-response.json @@ -1,14 +1,12 @@ { "member": { "admin_state_up": true, - "status": "PENDING_CREATE", - "status_description": null, "weight": 1, "address": "10.0.1.22", "project_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "protocol_port": 90, "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" + "subnet_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" } } diff --git a/api-ref/source/v2/samples/lbaas/member-show-response.json b/api-ref/source/v2/samples/lbaas/member-show-response.json index 9f1a7a010..3866459bd 100644 --- a/api-ref/source/v2/samples/lbaas/member-show-response.json +++ b/api-ref/source/v2/samples/lbaas/member-show-response.json @@ -1,14 +1,12 @@ { "member": { "admin_state_up": true, - "status": "ACTIVE", - "status_description": null, "weight": 1, "address": "10.0.1.22", "project_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "protocol_port": 90, "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" + "subnet_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" } } diff --git a/api-ref/source/v2/samples/lbaas/member-update-response.json b/api-ref/source/v2/samples/lbaas/member-update-response.json index 4c48023c8..fe681aca0 100644 --- a/api-ref/source/v2/samples/lbaas/member-update-response.json +++ b/api-ref/source/v2/samples/lbaas/member-update-response.json @@ -1,14 +1,12 @@ { "member": { "admin_state_up": true, - "status": "PENDING_UPDATE", - "status_description": null, "weight": 5, "address": "10.0.1.22", "project_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "protocol_port": 90, "id": "cf024846-7516-4e3a-b0fb-6590322c836f", - "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" + "subnet_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332" } } diff --git a/api-ref/source/v2/samples/lbaas/pool-create-request.json b/api-ref/source/v2/samples/lbaas/pool-create-request.json index 7797cd1b6..6d2ef785b 100644 --- a/api-ref/source/v2/samples/lbaas/pool-create-request.json +++ b/api-ref/source/v2/samples/lbaas/pool-create-request.json @@ -6,5 +6,6 @@ "name": "my-pool", "protocol": "HTTP", "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d" + "listener_id": "39de4d56-d663-46e5-85a1-5b9d5fa17829", } }