NSX-T Data Center REST API

Get a Policy Edge Cluster allocation status under an Enforcement Point

Returns the allocation details of cluster and its members. Lists the edge
node members, active and standby services of each node, utilization details
of configured sub-pools. These allocation details can be monitored by
customers to trigger migration of certain service contexts to different
edge nodes, to balance the utilization of edge node resources.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status
/policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status
Request Headers:
n/a
Query Parameters:
n/a
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/allocation/status

Successful Response:

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

Example Response:

Example 1: ---------- # Below Example for policy api created edge cluster { "edge_cluster_name": "my-edge-cluster-id", "member_count": 3, "members": [ { "member_index": 0, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id", "display_name": "my-edge-tn-id", "allocation_pools": [ { "active_service_count": 0, "standby_service_count": 0 } ], "allocated_services": [ { "service_reference": { "path": "fb919eee-8b9f-4847-a051-9fef236b8bb3", "target_display_name": "dhcp-server-my-T1-my-t1-seg" }, "high_availability_status": "UNKNOWN" } ] }, { "member_index": 1, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/1aa23bf4-63d6-46c4-9f70-f7c68c5a33c4", "display_name": "DHCPV4", "allocation_pools": [ { "active_service_count": 1, "standby_service_count": 1 } ], "allocated_services": [ { "service_reference": { "path": "/infra/tier-1s/my-T1", "target_display_name": "my-T1" }, "high_availability_status": "STANDBY" }, { "service_reference": { "path": "fb919eee-8b9f-4847-a051-9fef236b8bb3", "target_display_name": "dhcp-server-my-T1-my-t1-seg" }, "high_availability_status": "ACTIVE" } ] }, { "member_index": 2, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id-1", "display_name": "my-edge-tn-id-1", "allocation_pools": [ { "active_service_count": 1, "standby_service_count": 0 } ], "allocated_services": [ { "service_reference": { "path": "/infra/tier-1s/my-T1", "target_display_name": "my-T1" }, "high_availability_status": "ACTIVE" } ] } ] } Example 2: ---------- # Below Example for mp api created edge cluster { "edge_cluster_name": "EDGECLUSTER1", "member_count": 2, "members": [ { "member_index": 1, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/1a1a61cc-0782-11ef-a114-020017606fb0", "display_name": "mashish-svc-nsxedge-ob-23771564-2-magnus173760", "allocation_pools": [ { "active_service_count": 1, "standby_service_count": 1 } ], "allocated_services": [ { "service_reference": { "path": "ec30c6b2-fa9b-4f1e-a4a2-b7eb1b023504", "target_display_name": "it_t1-dhcp-server" }, "high_availability_status": "STANDBY" }, { "service_reference": { "path": "f66e7e7a-4971-4ad3-892d-688105666825", "target_display_name": "production_t1-dhcp-server" }, "high_availability_status": "ACTIVE" } ] }, { "member_index": 0, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/17365d30-0782-11ef-b9db-020017197055", "display_name": "mashish-svc-nsxedge-ob-23771564-1-magnus173760", "allocation_pools": [ { "active_service_count": 3, "standby_service_count": 1 } ], "allocated_services": [ { "service_reference": { "path": "/infra/tier-1s/production_t1", "target_display_name": "production_t1" }, "high_availability_status": "ACTIVE" }, { "service_reference": { "path": "/infra/tier-1s/it_t1", "target_display_name": "it_t1" }, "high_availability_status": "ACTIVE" }, { "service_reference": { "path": "ec30c6b2-fa9b-4f1e-a4a2-b7eb1b023504", "target_display_name": "it_t1-dhcp-server" }, "high_availability_status": "ACTIVE" }, { "service_reference": { "path": "f66e7e7a-4971-4ad3-892d-688105666825", "target_display_name": "production_t1-dhcp-server" }, "high_availability_status": "STANDBY" } ] } ] } Example 3: ---------- # Below Example for federation edge cluster allocation status api { "edge_cluster_name": "EDGECLUSTER1", "member_count": 2, "members": [ { "member_index": 0, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/ca5a1c20-0ddc-11ef-85e0-0201045807da", "display_name": "TN-200", "allocation_pools": [ { "active_service_count": 2, "standby_service_count": 1 } ], "allocated_services": [ { "service_reference": { "path": "/global-infra/segments/LS-104", "target_display_name": "LS-104" }, "high_availability_status": "ACTIVE", "allocation_details": [ { "key": "l2_forwarder_port", "value": "912507b0-a38a-4a32-8a49-da7005a4f069" } ] }, { "service_reference": { "path": "0108dee9-6b3c-42b3-a94f-67a65287d112", "target_display_name": "inter-site-bp-f2acad28-fa1a-4a10-b703-a5db5a80f14c" }, "high_availability_status": "ACTIVE", "allocation_details": [ { "key": "l2_forwarder_port", "value": "458795aa-ac29-4017-a31d-e3ccab0e82c9" } ] }, { "service_reference": { "path": "/global-infra/segments/LS-103", "target_display_name": "LS-103" }, "high_availability_status": "STANDBY", "allocation_details": [ { "key": "l2_forwarder_port", "value": "725198a5-61f6-43bf-be40-863476187c19" } ] } ] }, { "member_index": 1, "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/fc519104-0ddc-11ef-a758-0201045c2011", "display_name": "TN-201", "allocation_pools": [ { "active_service_count": 2, "standby_service_count": 1 } ], "allocated_services": [ { "service_reference": { "path": "/global-infra/segments/LS-104", "target_display_name": "LS-104" }, "high_availability_status": "STANDBY", "allocation_details": [ { "key": "l2_forwarder_port", "value": "912507b0-a38a-4a32-8a49-da7005a4f069" } ] }, { "service_reference": { "path": "0108dee9-6b3c-42b3-a94f-67a65287d112", "target_display_name": "inter-site-bp-f2acad28-fa1a-4a10-b703-a5db5a80f14c" }, "high_availability_status": "ACTIVE", "allocation_details": [ { "key": "l2_forwarder_port", "value": "458795aa-ac29-4017-a31d-e3ccab0e82c9" } ] }, { "service_reference": { "path": "/global-infra/segments/LS-103", "target_display_name": "LS-103" }, "high_availability_status": "ACTIVE", "allocation_details": [ { "key": "l2_forwarder_port", "value": "725198a5-61f6-43bf-be40-863476187c19" } ] } ] } ] }

Required Permissions:

read

Feature:

infra_admin

Additional Errors: