Read load balancer node usage summary
(Deprecated)
The API is used to retrieve the load balancer node usage summary of all
nodes for every enforcement point.
- If the parameter ?include_usages=true exists, the property node_usages
are included in response. By default, the property node_usages is not
included in response.
- If parameter ?enforcement_point_path=<enforcement-point-path> exists,
only node usage summary from specific enforcement point is included
in response. If no enforcement point path is specified, information will
be aggregated from each enforcement point.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.
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:
URI Path(s):
/policy/api/v1/infra/lb-node-usage-summary
Query Parameters:
LBNodeUsageSummaryRequestParameters+
enforcement_point_path |
enforcement point path
Specify enforcement point path.
|
string |
|
include_usages |
Whether to include usages
Specify whether to include usages in response.
|
boolean |
|
Successful Response:
Response Headers:
Content-type: application/json
Response Body:
AggregateLBNodeUsageSummary+
intent_path |
String Path of the intent object
Intent path of object, forward slashes must be escaped using %2F.
|
string |
Required Readonly |
results |
LBNodeUsageSummary list results
LBNodeUsageSummary list results. |
array of LBNodeUsageSummary |
Readonly |
Required Permissions:
read
Feature:
policy_statistics
Additional Errors: