NSX-T Data Center REST API

Read load balancer usage for the given node

API is used to retrieve node usage for load balancer which contains basic
information, LB entity usages and capacities for the given node.
Currently LB node usage per edge node and per virtual network appliance are
supported.
The parameter ?node_path=<node-path> is required. For example, ?node_path=
/infra/sites/default/enforcement-points/default/edge-clusters/
85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/0.

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.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/lb-node-usage

Request Headers:

n/a

Query Parameters:

LBNodeUsageRequestParameters+

LBNodeUsageRequestParameters (schema)

Name	Description	Type	Notes
node_path	The node path for load balancer node usage The property identifies the node path for load balancer node usage. For example, ?node_path=/infra/sites/default/enforcement-points/default /edge-clusters/85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes /86e077c0-449f-11e9-87c8-02004eb37029.	string	Required

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/lb-node-usage?node_path=/infra/sites/default/enforcement-points/default/edge-clusters/bfdda9bb-1db5-4d67-92f0-40f15f76259f/edge-nodes/0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LBEdgeNodeUsage+

LBEdgeNodeUsage (schema)

Name	Description	Type	Notes
current_large_load_balancer_count	The current large load balancer count The count of large load balancer services configured on the node.	integer	Readonly
current_load_balancer_credits	Current load balancer credits The current load balancer credits means the current credits used 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_medium_load_balancer_count	The current medium load balancer count The count of medium load balancer services configured on the node.	integer	Readonly
current_pool_count	The current pool count. The count of pools configured on the node.	integer	Readonly
current_pool_member_count	The current pool member count The count of pool members configured on the node.	integer	Readonly
current_small_load_balancer_count	The current small load balancer count The count of small load balancer services configured on the node.	integer	Readonly
current_virtual_server_count	The current virtual server count The count of virtual servers configured on the node.	integer	Readonly
current_xlarge_load_balancer_count	The current xlarge load balancer count The count of xlarge load balancer services configured on the node.	integer	Readonly
edge_cluster_path	The path of edge cluster The path of edge cluster which contains the edge node.	string	Readonly
form_factor	The form factor of the given edge node or virtual network appliance The form factor of the given edge node or virtual network appliance.	string	Readonly Enum: SMALL_VIRTUAL_MACHINE, MEDIUM_VIRTUAL_MACHINE, LARGE_VIRTUAL_MACHINE, XLARGE_VIRTUAL_MACHINE, PHYSICAL_MACHINE
load_balancer_credit_capacity	Load balancer credit capacity The load balancer credit capacity means the maximum credits which can be used for load balancer configuration for the given edge node.	integer	Readonly
node_path	The node path for load balancer node usage The property identifies the node path for load balancer node usage. For example, node_path=/infra/sites/default/enforcement-points/default /edge-clusters/85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes /86e077c0-449f-11e9-87c8-02004eb37029.	string	Required
pool_member_capacity	The pool member capacity This is a deprecated property. There is no LB pool member limit per edge node or per virtual network appliance anymore. For backward compatible consideration, for edge node, the property value is set as the max configurable pool member number of the largest supported LB size on the edge node. For example, for XLARGE edge, the property value is 36000. For virtual network appliance, the property value is not used anymore.	integer	Deprecated Readonly
remaining_large_load_balancer_count	The remaining large load balancer count The remaining count of large load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_medium_load_balancer_count	The remaining medium load balancer count The remaining count of medium load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_small_load_balancer_count	The remaining small load balancer count The remaining count of small load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_xlarge_load_balancer_count	The remaining xlarge load balancer count The remaining count of xlarge load balancer services which can be configured on the given edge node.	integer	Readonly
resource_type	Must be set to the value LBEdgeNodeUsage	string	Required
severity	LB usage severity The severity calculation is based on current credit usage percentage of load balancer for one node.	LBUsageSeverity	Readonly
usage_percentage	Usage percentage The usage percentage of the edge node for load balancer. The value is the load balancer credit usage percentage.	number	Readonly

LBVirtualNetworkApplianceUsage+

LBVirtualNetworkApplianceUsage (schema)

Name	Description	Type	Notes
current_large_load_balancer_count	The current large load balancer count The count of large load balancer services configured on the node.	integer	Readonly
current_load_balancer_credits	Current load balancer credits The current load balancer credits means the current credits used 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_medium_load_balancer_count	The current medium load balancer count The count of medium load balancer services configured on the node.	integer	Readonly
current_pool_count	The current pool count. The count of pools configured on the node.	integer	Readonly
current_pool_member_count	The current pool member count The count of pool members configured on the node.	integer	Readonly
current_small_load_balancer_count	The current small load balancer count The count of small load balancer services configured on the node.	integer	Readonly
current_virtual_server_count	The current virtual server count The count of virtual servers configured on the node.	integer	Readonly
current_xlarge_load_balancer_count	The current xlarge load balancer count The count of xlarge load balancer services configured on the node.	integer	Readonly
form_factor	The form factor of the given edge node or virtual network appliance The form factor of the given edge node or virtual network appliance.	string	Readonly Enum: SMALL_VIRTUAL_MACHINE, MEDIUM_VIRTUAL_MACHINE, LARGE_VIRTUAL_MACHINE, XLARGE_VIRTUAL_MACHINE, PHYSICAL_MACHINE
load_balancer_credit_capacity	Load balancer credit capacity The load balancer credit capacity means the maximum credits which can be used for load balancer configuration for the given edge node.	integer	Readonly
node_path	The node path for load balancer node usage The property identifies the node path for load balancer node usage. For example, node_path=/infra/sites/default/enforcement-points/default /edge-clusters/85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes /86e077c0-449f-11e9-87c8-02004eb37029.	string	Required
remaining_large_load_balancer_count	The remaining large load balancer count The remaining count of large load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_medium_load_balancer_count	The remaining medium load balancer count The remaining count of medium load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_small_load_balancer_count	The remaining small load balancer count The remaining count of small load balancer services which can be configured on the given edge node.	integer	Readonly
remaining_xlarge_load_balancer_count	The remaining xlarge load balancer count The remaining count of xlarge load balancer services which can be configured on the given edge node.	integer	Readonly
resource_type	Must be set to the value LBVirtualNetworkApplianceUsage	string	Required
severity	LB usage severity The severity calculation is based on current credit usage percentage of load balancer for one node.	LBUsageSeverity	Readonly
usage_percentage	Usage percentage The usage percentage of the edge node for load balancer. The value is the load balancer credit usage percentage.	number	Readonly
virtual_network_appliance_cluster_path	The path of virtual network appliance cluster The path of virtual network appliance cluster which contains the virtual network appliance.	string	Readonly

Example Response:

{ "form_factor" : "MEDIUM_VIRTUAL_MACHINE", "edge_cluster_path" : "/infra/sites/default/enforcement-points/default/edge-clusters/bfdda9bb-1db5-4d67-92f0-40f15f76259f", "current_load_balancer_credits" : 3, "load_balancer_credit_capacity" : 10, "usage_percentage" : 30.0, "severity" : "GREEN", "current_pool_member_count" : 4, "current_virtual_server_count" : 3, "current_pool_count" : 3, "pool_member_capacity" : 20000, "current_small_load_balancer_count" : 3, "current_medium_load_balancer_count" : 0, "current_large_load_balancer_count" : 0, "current_xlarge_load_balancer_count" : 0, "remaining_small_load_balancer_count" : 7, "remaining_medium_load_balancer_count" : 0, "remaining_large_load_balancer_count" : 0, "remaining_xlarge_load_balancer_count" : 0, "resource_type" : "LBEdgeNodeUsage", "node_path" : "/infra/sites/default/enforcement-points/default/edge-clusters/bfdda9bb-1db5-4d67-92f0-40f15f76259f/edge-nodes/0" }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors:

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