Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Usage

Associated URIs:

API Description API Path

Read load balancer usage for the given node


API is used to retrieve node usage for load balancer which contains basic
information, LB entity usages and capacities for the given node.
Currently only edge node is supported.
The parameter ?node_path= is required. For example, ?node_path=
/infra/sites/default/enforcement-points/default/edge-clusters/
85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/
86e077c0-449f-11e9-87c8-02004eb37029.
GET /policy/api/v1/infra/lb-node-usage

Read load balancer node usage summary


The API is used to retrieve the load balancer node usage summary of all
nodes for every enforcement point.
- If the parameter ?include_usages=true exists, the property node_usages
are included in response. By default, the property node_usages is not
included in response.
- If parameter ?enforcement_point_path= exists,
only node usage summary from specific enforcement point is included
in response. If no enforcement point path is specified, information will
be aggregated from each enforcement point.
GET /policy/api/v1/infra/lb-node-usage-summary

Read load balancer service usage summary


API is used to retrieve the load balancer usage summary for
all load balancer services.
If the parameter ?include_usages=true exists, the property service-usages
is included in the response. By default, service-usages is not included
in the response.
GET /policy/api/v1/infra/lb-service-usage-summary

Get LBService usage information


Get LBServiceUsage information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/service-usage