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.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/lb-service-usage-summary

Request Headers:

n/a

Query Parameters:

LBUsageSummaryRequestParameters+

LBUsageSummaryRequestParameters (schema)

Name	Description	Type	Notes
include_usages	Whether to include usages Specify whether to include usages in response.	boolean

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LBServiceUsageSummary+

LBServiceUsageSummary (schema)

Name	Description	Type	Notes
current_pool_count	The current pool count The current count of pools configured for all load balancer services.	integer	Readonly
current_pool_member_count	The current pool member count The current count of pool members configured for all load balancer services.	integer	Readonly
current_virtual_server_count	The current virtual server count The current count of virtual servers configured for all load balancer services.	integer	Readonly
pool_capacity	The capacity of pools Pool capacity means maximum number of pools which can be configured for all load balancer services.	integer	Readonly
pool_member_capacity	The capacity of pool members Pool capacity means maximum number of pool members which can be configured for all load balancer services.	integer	Readonly
pool_member_severity	LB usage severity The severity calculation is based on the overall usage percentage of pool members for all load balancer services.	LBUsageSeverity	Readonly
pool_member_usage_percentage	Pool member usage percentage Overall pool member usage percentage for all load balancer services.	number	Readonly
pool_severity	LB usage severity The severity calculation is based on the overall usage percentage of pools for all load balancer services.	LBUsageSeverity	Readonly
pool_usage_percentage	Pool usage percentage Overall pool usage percentage for all load balancer services.	number	Readonly
service_counts	LB service count for each severity The service count for each load balancer usage severity.	array of LBServiceCountPerSeverity	Readonly
service_usages	LB service usages The property identifies all lb service usages. By default, it is not included in response. It exists when parameter ?include_usages=true.	array of LBServiceUsage	Readonly
virtual_server_capacity	The capacity of virtual servers Virtual server capacity means maximum number of virtual servers which can be configured for all load balancer services.	integer	Readonly
virtual_server_severity	LB usage severity The severity calculation is based on the overall usage percentage of virtual servers for all load balancer services.	LBUsageSeverity	Readonly
virtual_server_usage_percentage	Virtual server usage percentage Overall virtual server usage percentage for all load balancer services.	number	Readonly

Required Permissions:

read

Feature:

policy_statistics

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable