NSX-T Data Center REST API

Get load balancer status information

Get load balancer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

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.
This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/detailed-status
Request Headers:
n/a
Query Parameters:
PolicyRuntimeRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1/detailed-status

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AggregateLBServiceStatus+

Example Response:

{ "results" : [ { "service_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1", "service_status" : "UP", "virtual_servers" : [ { "virtual_server_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lb-virtual-servers/vs-0", "status" : "DOWN", "resource_type" : "LBVirtualServerStatus" } ], "pools" : [ { "pool_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lb-pools/pool-0", "members" : [ { "ip_address" : "192.168.100.164", "port" : "80", "status" : "DOWN", "failure_cause" : "Failed to connect, the reason is Network is unreachable.", "last_state_change_time" : 1739329663945 } ], "status" : "DOWN", "resource_type" : "LBPoolStatus" } ], "memory_usage" : 2, "cpu_usage" : 0, "active_transport_nodes" : [ "180276b2-e45f-11ef-bb9e-02007862ae61" ], "standby_transport_nodes" : [ "1f30e39c-e45f-11ef-afd9-02007874a2ce" ], "last_update_timestamp" : 1739329763283, "enforcement_point_path" : "/infra/sites/default/enforcement-points/default", "resource_type" : "LBServiceStatus" } ], "intent_path" : "/orgs/default/projects/project-1/vpcs/vpc-1/vpc-lbs/lb-1" }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: