Policy > Networking > Network Services > Load Balancing > Load Balancer 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=<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 (Deprecated)

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=<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 (Deprecated)

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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-service-usage-summary

Get LBService status information


Get LBService detailed status 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/detailed-status

Get LBPool status information


Get LBPool detailed status 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/detailed-status

Get LBPool statistics information


Get LBPoolStatistics 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/statistics

Get LBVirtualServer status information


Get LBVirtualServer detailed status 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/detailed-status

Get LBVirtualServer statistics information


Get LBVirtualServerStatistics 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/statistics

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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/service-usage

Get LBService statistics information


Get LBServiceStatistics 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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/statistics