NSX-T Data Center REST API

Get a Policy Edge Cluster real time status under an Enforcement Point

Returns the aggregated status for the Edge cluster along with status of
all edge nodes in the cluster.
Query parameter "source=realtime" is the only supported source.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status
/policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status
Request Headers:
n/a
Query Parameters:
PolicyEdgeClusterStatusRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/status?source=realtime

Successful Response:

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

Example Response:

Example 1: ---------- # Below Example for policy api created edge cluster GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/status?source=realtime { "edge_cluster_name": "my-edge-cluster-id", "member_status": [ { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id", "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/edge-nodes/0", "status": "DOWN" }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/1aa23bf4-63d6-46c4-9f70-f7c68c5a33c4", "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/edge-nodes/my-policy-edge-node", "status": "UP" }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id-1", "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/edge-nodes/2", "status": "UP" } ], "last_update_timestamp": 1715239056405, "edge_cluster_status": "DEGRADED" } Example 2: ---------- # Below Example for mp api created edge cluster GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/c0e55af1-6ee1-4588-84dc-d8f126bec580?source=realtime { "edge_cluster_name": "EDGECLUSTER2", "member_status": [ { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/179eaf5c-0782-11ef-ad72-020017f1f33d", "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/c0e55af1-6ee1-4588-84dc-d8f126bec580/edge-nodes/1", "status": "UP" }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/027b1f48-0782-11ef-acf3-0200176507c1", "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/c0e55af1-6ee1-4588-84dc-d8f126bec580/edge-nodes/0", "status": "UP" } ], "last_update_timestamp": 1715239172312, "edge_cluster_status": "UP" }

Required Permissions:

read

Feature:

infra_admin

Additional Errors: