doc-exports/elb/api-ref/DeleteLoadBalancer.rst

73 lines
1.7 KiB
ReStructuredText

Deleting a Load Balancer
========================
Function
^^^^^^^^
This API is used to delete a load balancer.
Constraints
^^^^^^^^^^^
All listeners added to the load balancer must be deleted before the load balancer is deleted.
URI
^^^
DELETE /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
.. table:: **Table 1** Path parameters
=============== ========= ====== ===============================
Parameter Mandatory Type Description
=============== ========= ====== ===============================
project_id Yes String Specifies the project ID.
loadbalancer_id Yes String Specifies the load balancer ID.
=============== ========= ====== ===============================
Request Parameters
^^^^^^^^^^^^^^^^^^
.. table:: **Table 2** Request header parameters
============ ========= ====== ================================================
Parameter Mandatory Type Description
============ ========= ====== ================================================
X-Auth-Token Yes String Specifies the token used for IAM authentication.
============ ========= ====== ================================================
Response Parameters
^^^^^^^^^^^^^^^^^^^
None
Example Requests
^^^^^^^^^^^^^^^^
.. code:: screen
DELETE
https://{elb_endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
Example Responses
^^^^^^^^^^^^^^^^^
None
Status Codes
^^^^^^^^^^^^
=========== ===================
Status Code Description
=========== ===================
204 Successful request.
=========== ===================
Error Codes
^^^^^^^^^^^
See `Error Codes <errorcode.html>`__.
**Parent topic:** `Load Balancer <topic_300000003.html>`__