API Description | API Path |
---|---|
Retrieve a paginated list of load balancer application profilesRetrieve a paginated list of load balancer application profiles. |
GET /api/v1/loadbalancer/application-profiles
|
Create a load balancer application profileCreate a load balancer application profile. |
POST /api/v1/loadbalancer/application-profiles
|
Delete a load balancer application profileDelete a load balancer application profile. |
DELETE /api/v1/loadbalancer/application-profiles/<application-profile-id>
|
Retrieve a load balancer application profileRetrieve a load balancer application profile. |
GET /api/v1/loadbalancer/application-profiles/<application-profile-id>
|
Update a load balancer application profileUpdate a load balancer application profile. |
PUT /api/v1/loadbalancer/application-profiles/<application-profile-id>
|
Retrieve a paginated list of load balancer client-ssl profilesRetrieve a paginated list of load balancer client-ssl profiles. |
GET /api/v1/loadbalancer/client-ssl-profiles
|
Create a load balancer client-ssl profileCreate a load balancer client-ssl profile. |
POST /api/v1/loadbalancer/client-ssl-profiles
|
Delete a load balancer client-ssl profileDelete a load balancer client-ssl profile. |
DELETE /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
|
Retrieve a load balancer client-ssl profileRetrieve a load balancer client-ssl profile. |
GET /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
|
Update a load balancer client-ssl profileUpdate a load balancer client-ssl profile. |
PUT /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
|
Retrieve a paginated list of load balancer monitorsRetrieve a paginated list of load balancer monitors. |
GET /api/v1/loadbalancer/monitors
|
Create a load balancer monitorCreate a load balancer monitor. |
POST /api/v1/loadbalancer/monitors
|
Delete a load balancer monitorDelete a load balancer monitor. |
DELETE /api/v1/loadbalancer/monitors/<monitor-id>
|
Retrieve a load balancer monitorRetrieve a load balancer monitor. |
GET /api/v1/loadbalancer/monitors/<monitor-id>
|
Update a load balancer monitorUpdate a load balancer monitor. |
PUT /api/v1/loadbalancer/monitors/<monitor-id>
|
Read load balancer node usage summaryAPI is used to retrieve the load balancer node usage summary for all nodes. |
GET /api/v1/loadbalancer/node-usage-summary
|
Retrieve a paginated list of load balancer persistence profilesRetrieve a paginated list of load balancer persistence profiles. |
GET /api/v1/loadbalancer/persistence-profiles
|
Create a load balancer persistence profileCreate a load balancer persistence profile. |
POST /api/v1/loadbalancer/persistence-profiles
|
Delete a load balancer persistence profileDelete a load balancer persistence profile. |
DELETE /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
|
Retrieve a load balancer persistence profileRetrieve a load balancer persistence profile. |
GET /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
|
Update a load balancer persistence profileUpdate a load balancer persistence profile. |
PUT /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
|
Retrieve a paginated list of load balancer poolsRetrieve a paginated list of load balancer pools. |
GET /api/v1/loadbalancer/pools
|
Create a load balancer poolCreate a load balancer pool. |
POST /api/v1/loadbalancer/pools
|
Delete a load balancer poolDelete a load balancer pool. |
DELETE /api/v1/loadbalancer/pools/<pool-id>
|
Retrieve a load balancer poolRetrieve a load balancer pool. |
GET /api/v1/loadbalancer/pools/<pool-id>
|
Add, remove, or modify load balancer pool membersFor ADD_MEMBERS, pool members will be created and added to load balancer pool. This action is only valid for static pool members. For REMOVE_MEMBERS, pool members will be removed from load balancer pool via IP and port in pool member settings. This action is only valid for static pool members. For UPDATE_MEMBERS, pool members admin state will be updated. This action is valid for both static pool members and dynamic pool members. For dynamic pool members, this update will be stored in customized_members field in load balancer pool member group. |
POST /api/v1/loadbalancer/pools/<pool-id>
|
Update a load balancer poolUpdate a load balancer pool. |
PUT /api/v1/loadbalancer/pools/<pool-id>
|
Retrieve a paginated list of load balancer rulesRetrieve a paginated list of load balancer rules. |
GET /api/v1/loadbalancer/rules
|
Create a load balancer ruleCreate a load balancer rule. |
POST /api/v1/loadbalancer/rules
|
Delete a load balancer ruleDelete a load balancer rule. |
DELETE /api/v1/loadbalancer/rules/<rule-id>
|
Retrieve a load balancer ruleRetrieve a load balancer rule. |
GET /api/v1/loadbalancer/rules/<rule-id>
|
Update a load balancer ruleUpdate a load balancer rule. |
PUT /api/v1/loadbalancer/rules/<rule-id>
|
Retrieve a paginated list of load balancer server-ssl profilesRetrieve a paginated list of load balancer server-ssl profiles. |
GET /api/v1/loadbalancer/server-ssl-profiles
|
Create a load balancer server-ssl profileCreate a load balancer server-ssl profile. |
POST /api/v1/loadbalancer/server-ssl-profiles
|
Delete a load balancer server-ssl profileDelete a load balancer server-ssl profile. |
DELETE /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
|
Retrieve a load balancer server-ssl profileRetrieve a load balancer server-ssl profile. |
GET /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
|
Update a load balancer server-ssl profileUpdate a load balancer server-ssl profile. |
PUT /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
|
Retrieve a paginated list of load balancer servicesRetrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned. |
GET /api/v1/loadbalancer/services
|
Create a load balancer serviceCreate a load balancer service. |
POST /api/v1/loadbalancer/services
|
Delete a load balancer serviceDelete a load balancer service. |
DELETE /api/v1/loadbalancer/services/<service-id>
|
Retrieve a load balancer serviceRetrieve a load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>
|
Update a load balancer serviceUpdate a load balancer service. |
PUT /api/v1/loadbalancer/services/<service-id>
|
Read the debug information of the load balancer serviceAPI to download below information which will be used for debugging and troubleshooting. 1) Load balancer service 2) Load balancer associated virtual servers 3) Load balancer associated pools 4) Load balancer associated profiles such as persistence, SSL, application. 5) Load balancer associated monitors 6) Load balancer associated rules |
GET /api/v1/loadbalancer/services/<service-id>/debug-info
|
Get the statistics of load balancer poolReturns the statistics of the given load balancer pool by given load balancer serives id and load balancer pool id. Currently, only realtime mode is supported. |
GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/statistics
|
Get the status of load balancer poolReturns the status of the given load balancer pool by given load balancer serives id and load balancer pool id. |
GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/status
|
Get the statistics list of load balancer poolsReturns the statistics list of load balancer pools in given load balancer service. Currently, only realtime mode is supported. |
GET /api/v1/loadbalancer/services/<service-id>/pools/statistics
|
Get the status list of load balancer poolsReturns the status list of load balancer pools in given load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>/pools/status
|
Get the statistics of load balancer serviceReturns the statistics of the given load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>/statistics
|
Get the status of the given load balancer serviceReturns the status of the given load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>/status
|
Read the usage information of the given load balancer serviceAPI to fetch the capacity and current usage of the given load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>/usage
|
Get the statistics of the given load balancer virtual serverReturns the statistics of the load balancer virtual server by given load balancer serives id and load balancer virtual server id. |
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/statistics
|
Get the status of the load balancer virtual serverReturns the status of the virtual server by given load balancer serives id and load balancer virtual server id. |
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/status
|
Get the statistics list of virtual serversReturns the statistics list of virtual servers in given load balancer service. Currently, only realtime mode is supported. |
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/statistics
|
Get the status list of virtual servers in given load balancer serviceReturns the status list of virtual servers in given load balancer service. |
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/status
|
Retrieve a list of supported SSL ciphers and protocolsRetrieve a list of supported SSL ciphers and protocols. |
GET /api/v1/loadbalancer/ssl/ciphers-and-protocols
|
Read load balancer usage for the given nodeAPI is used to retrieve the usage of load balancer entities which include current number and remaining number of credits, virtual Servers, pools, pool Members and different size of LB services from the given node. Currently only Edge node is supported. |
GET /api/v1/loadbalancer/usage-per-node/<node-id>
|
Retrieve a paginated list of load balancer virtual serversRetrieve a paginated list of load balancer virtual servers. |
GET /api/v1/loadbalancer/virtual-servers
|
Create a load balancer virtual serverCreate a load balancer virtual server. |
POST /api/v1/loadbalancer/virtual-servers
|
Create a load balancer virtual server with rulesIt is used to create virtual servers, the associated rules and bind the rules to the virtual server. To add new rules, make sure the rules which have no identifier specified, the new rules are automatically generated and associated to the virtual server. If the virtual server need to consume some existed rules without change, those rules should not be specified in this array, otherwise, the rules are updated. |
POST /api/v1/loadbalancer/virtual-servers?action=create_with_rules
|
Delete a load balancer virtual serverDelete a load balancer virtual server. |
DELETE /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
|
Retrieve a load balancer virtual serverRetrieve a load balancer virtual server. |
GET /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
|
Update a load balancer virtual server with rulesIt is used to update virtual servers, the associated rules and update the binding of virtual server and rules. To add new rules, make sure the rules which have no identifier specified, the new rules are automatically generated and associated to the virtual server. To delete old rules, the rules should not be configured in new action, the UUID of deleted rules should be also removed from rule_ids. To update rules, the rules should be specified with new change and configured with identifier. If there are some rules which are not modified, those rule should not be specified in the rules list, the UUID list of rules should be specified in rule_ids of LbVirtualServer. |
PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id>?action=update_with_rules
|
Update a load balancer virtual serverUpdate a load balancer virtual server. |
PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
|