NSX-T Data Center REST API

Get load balancer statistics information

Get load balancer statistics 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.
This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/statistics
Request Headers:
n/a
Query Parameters:
PolicyRuntimeRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1/statistics?source=realtime

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AggregateLBServiceStatistics+

Example Response:

{ "results" : [ { "service_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1", "virtual_servers" : [ { "virtual_server_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lb-virtual-servers/vs-0", "statistics" : { "current_sessions" : 0, "max_sessions" : 0, "total_sessions" : 0, "bytes_in" : 0, "bytes_out" : 0, "packets_in" : 0, "packets_out" : 0, "current_session_rate" : 0.0, "dropped_packets_by_access_list" : 0 }, "last_update_timestamp" : 1739329860085, "enforcement_point_path" : "/infra/sites/default/enforcement-points/default", "resource_type" : "LBVirtualServerStatistics" } ], "pools" : [ { "pool_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lb-pools/pool-0", "statistics" : { "current_sessions" : 0, "max_sessions" : 0, "total_sessions" : 0, "bytes_in" : 0, "bytes_out" : 0, "packets_in" : 0, "packets_out" : 0, "current_session_rate" : 0.0 }, "members" : [ { "ip_address" : "192.168.100.164", "port" : "80", "statistics" : { "current_sessions" : 0, "max_sessions" : 0, "total_sessions" : 0, "bytes_in" : 0, "bytes_out" : 0, "packets_in" : 0, "packets_out" : 0, "current_session_rate" : 0.0 } } ], "last_update_timestamp" : 1739329860089, "enforcement_point_path" : "/infra/sites/default/enforcement-points/default", "resource_type" : "LBPoolStatistics" } ], "last_update_timestamp" : 1739329860089, "statistics" : { "l4_current_sessions" : 0, "l4_max_sessions" : 0, "l4_total_sessions" : 0, "l4_current_session_rate" : 0.0, "l7_current_sessions" : 0, "l7_max_sessions" : 0, "l7_total_sessions" : 0, "l7_current_session_rate" : 0.0 }, "enforcement_point_path" : "/infra/sites/default/enforcement-points/default", "resource_type" : "LBServiceStatistics" } ], "intent_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1" }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: