NSX-T Data Center REST API

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.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/lb-services/{lb-service-id}/service-usage
Request Headers:
n/a
Query Parameters:
PolicyRuntimeRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/lb-services/lb-1/service-usage

Successful Response:

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

Example Response:

{ "results" : [ { "service_path" : "/infra/lb-services/lb-1", "service_size" : "SMALL", "virtual_server_capacity" : 20, "pool_capacity" : 60, "pool_member_capacity" : 400, "current_virtual_server_count" : 1, "current_pool_count" : 1, "current_pool_member_count" : 1, "usage_percentage" : 5.0, "severity" : "GREEN", "last_update_timestamp" : 1739345643255, "enforcement_point_path" : "/infra/sites/default/enforcement-points/default", "resource_type" : "LBServiceUsage" } ], "intent_path" : "/infra/lb-services/lb-1" }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: