NSX-T Data Center REST API

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.
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-service-usage-summary
Request Headers:
n/a
Query Parameters:
LBUsageSummaryRequestParameters+
Request Body:
n/a

Example Request:

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

Successful Response:

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

Example Response:

{ "pool_usage_percentage" : 1.67, "pool_severity" : "GREEN", "pool_capacity" : 180, "current_pool_count" : 3, "virtual_server_usage_percentage" : 5.0, "virtual_server_severity" : "GREEN", "virtual_server_capacity" : 60, "current_virtual_server_count" : 3, "pool_member_usage_percentage" : 0.33, "pool_member_severity" : "GREEN", "pool_member_capacity" : 1200, "current_pool_member_count" : 4, "service_counts" : [ { "severity" : "RED", "service_count" : 0 }, { "severity" : "ORANGE", "service_count" : 0 }, { "severity" : "GREEN", "service_count" : 3 } ] }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: