NSX-T Data Center REST API

Read load balancer usage for the given node (Deprecated)

API is used to retrieve the usage of load balancer entities which include
current number and remaining number of credits, virtual Servers, pools,
pool Members and different size of LB services from the given node.
Currently only Edge node is supported.
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/usage-per-node/{node-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbEdgeNodeUsage+

LbEdgeNodeUsage (schema)

(Deprecated)

Name	Description	Type	Notes
current_credit_number	Current credit number The current credit number reflects the current usage on the node. For example, configuring a medium load balancer on a node consumes 10 credits. If there are 2 medium instances configured on a node, the current credit number is 2 * 10 = 20.	integer	Readonly
current_large_load_balancer_services	The current number of large load balancer services The number of large load balancer services configured on the node.	integer	Readonly
current_medium_load_balancer_services	The current number of medium load balancer services The number of medium load balancer services configured on the node.	integer	Readonly
current_pool_members	The current number of pool members The number of pool members configured on the node.	integer	Readonly
current_pools	The current number of pools The number of pools configured on the node.	integer	Readonly
current_small_load_balancer_services	The current number of small load balancer services The number of small load balancer services configured on the node.	integer	Readonly
current_virtual_servers	The current number of virtual servers The number of virtual servers configured on the node.	integer	Readonly
current_xlarge_load_balancer_services	The current number of xlarge load balancer services The number of xlarge load balancer services configured on the node.	integer	Readonly
edge_cluster_id	The ID of edge cluster The ID of edge cluster which contains the edge node.	string	Readonly
form_factor	The form factor of the given edge node The form factor of the given edge node.	string	Readonly Enum: SMALL_VIRTUAL_MACHINE, MEDIUM_VIRTUAL_MACHINE, LARGE_VIRTUAL_MACHINE, XLARGE_VIRTUAL_MACHINE, PHYSICAL_MACHINE
node_id	The UUID of the node for load balancer node usage The property identifies the node UUID for load balancer node usage.	string	Required
remaining_credit_number	Remaining credit number The remaining credit number is the remaining credits that can be used for load balancer service configuration. For example, an edge node with form factor LARGE_VIRTUAL_MACHINE has 40 credits, and a medium load balancer instance costs 10 credits. If there are currently 3 medium instances configured, the remaining credit number is 40 - (3 * 10) = 10.	integer	Readonly
remaining_large_load_balancer_services	The remaining number of large load balancer services The remaining number of large load balancer services which could be configured on the given edge node.	integer	Readonly
remaining_medium_load_balancer_services	The remaining number of medium load balancer services The remaining number of medium load balancer services which could be configured on the given edge node.	integer	Readonly
remaining_pool_members	The remaining number of pool members The remaining number of pool members which could be configured on the given edge node.	integer	Readonly
remaining_small_load_balancer_services	The remaining number of small load balancer services The remaining number of small load balancer services which could be configured on the given edge node.	integer	Readonly
remaining_xlarge_load_balancer_services	The remaining number of xlarge load balancer services The remaining number of xlarge load balancer services which could be configured on the given edge node.	integer	Readonly
severity	LB usage severity The severity calculation is based on current credit usage percentage of load balancer for one node.	LbUsageSeverity	Readonly
type	Must be set to the value LbEdgeNodeUsage	LbNodeUsageType	Required
usage_percentage	Usage percentage The usage percentage of the edge node for load balancer. The value is the larger value between load balancer credit usage percentage and pool member usage percentage for the edge node.	number	Readonly

Example Response:

{ "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:

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