NSX-T Data Center REST API

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 LB node usage per edge node and per virtual network appliance are
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/0.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
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=<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.
- If parameter ?node_type=VirtualNetworkAppliance exists, it will only
return the LB node usage summary for virtual network appliances. If
parameter ?node_type=EdgeNode exists, it will only return the LB node usage
summary for edge nodes. If the parameter is not specified, it will return
LB node usage summary for both edge nodes and virtual network appliances.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
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.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
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.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/infra/lb-services/{lb-service-id}/service-usage

Get LB node capacity


API is used to retrieve available load balancer capacity status for all
edge or virtual network appliance clusters shared with Project.
If the parameter ?service_cluster_path=<service-cluster-path> exists,
then API only shows the available load balancer capacity status for this
specific edge or virtual network appliance cluster.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/lb-node-capacity-status

Get LB node capacity


API is used to retrieve available load balancer capacity status for the
edge or virtual network appliance clusters shared with VPC.
If the parameter ?service_cluster_path=<service-cluster-path> exists,
then API only shows the available load balancer capacity status for this
specific edge cluster or virtual network appliance cluster.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-node-capacity-status

Get load balancer usage information


Get load balancer usage 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.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/usage