Read load balancer node usage summary

API is used to retrieve the load balancer node usage summary for all nodes.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/node-usage-summary

Request Headers:

n/a

Query Parameters:

LbNodeUsageSummaryRequestParameters+

Name	Description	Type	Notes
include_usages	Whether to include node usages Specify whether to include node usages in response. By default, it is false which means node usages are not included in LbNodeUsageSummary response.	boolean

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/loadbalancer/node-usage-summary?include_usages=true

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbNodeUsageSummary+

LbNodeUsageSummary (schema)

Name	Description	Type	Notes
current_credit_number	Current credit number The current credit number reflects the overall credit usage for all nodes.	integer	Readonly
current_pool_members	The current number of pool members The overall number of pool members configured on all nodes.	integer	Readonly
node_counts	Array of node count for each severity The property identifies array of node count for each severity (RED, ORANGE and GREEN).	array of LbNodeCountPerSeverity	Readonly
node_usages	Array of lb node usages The property contains lb node usages for each node.	array of LbNodeUsage (Abstract type: pass one of the following concrete types) LbEdgeNodeUsage	Readonly
remaining_credit_number	Remaining credit number The remaining credit number is the overall remaining credits that can be used for load balancer service configuration for all nodes.	integer	Readonly
remaining_pool_members	The remaining number of pool members The overall remaining number of pool members which could be configured on all nodes.	integer	Readonly
severity	LB usage severity The severity calculation is based on current credit usage percentage of load balancer for all nodes.	LbUsageSeverity	Readonly
usage_percentage	Usage percentage The overall usage percentage of all nodes for load balancer. The value is the larger value between overall pool member usage percentage and overall load balancer credit usage percentage.	number	Readonly

Example Response:

{ "current_credit_number" : 1, "remaining_credit_number" : 39, "usage_percentage" : 2.5, "severity" : "GREEN", "node_counts" : [{ "severity" : "GREEN", "node_count" : 1, },{ "severity" : "ORANGE", "node_count" : 0, },{ "severity" : "RED", "node_count" : 0, }] "node_usages" : [{ "type" : "LbEdgeNodeUsage", "node_id" : "56ad0d8a-6cec-43ea-a30f-a83a4128944d", "edge_cluster_id" : "56ad0d8a-6cec-43ea-a30f-a83a4128944e", "form_factor" : "LARGE_VIRTUAL_MACHINE", "current_credit_number" : 1, "remaining_credit_number" : 39, "usage_percentage" : 2.5, "severity" : "GREEN", "current_pool_members" : 10, "current_virtual_servers" : 2, "current_pools" : 2, "current_small_load_balancer_services" : 1, "current_medium_load_balancer_services" : 0, "current_large_load_balancer_services" : 0, "current_xlarge_load_balancer_services" : 0, "remaining_small_load_balancer_services" : 39, "remaining_medium_load_balancer_services" : 3, "remaining_large_load_balancer_services" : 0, "remaining_xlarge_load_balancer_services" : 0, "remaining_pool_members" : 7490 }] }

Read load balancer node usage summary

Request:

LbNodeUsageSummaryRequestParameters (schema)

Example Request:

Successful Response:

LbNodeUsageSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: