NSX-T Data Center REST API

Read load balancer node usage summary (Deprecated)

API is used to retrieve the load balancer node usage summary for all nodes.
Deprecated:
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

Request:

Method:
GET
URI Path(s):
/api/v1/loadbalancer/node-usage-summary
Request Headers:
n/a
Query Parameters:
LbNodeUsageSummaryRequestParameters+
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+

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 }] }

Required Permissions:

read

Feature:

lb_services

Additional Errors: