Get the Allocation details of an edge cluster

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):

/api/v1/edge-clusters/{edge-cluster-id}/allocation-status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/edge-clusters/bf8d4daf-93f6-4c23-af38-63f6d372e14e/allocation-status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EdgeClusterAllocationStatus+

Name	Description	Type	Notes
display_name	Display name of the edge cluster	string	Readonly
id	Unique identifier of edge cluster System allotted UUID of edge cluster.	string	Readonly
member_count	Count of edge nodes present in the cluster Represents the number of edge nodes in the cluster.	int	Readonly
members	Allocation Status of edge nodes Allocation details of edge nodes present in the cluster.	array of EdgeMemberAllocationStatus	Readonly

Required Permissions:

read

Feature:

nodes_edge_clusters

Additional Errors:

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

Get the Allocation details of an edge cluster

Request:

Example Request:

Successful Response:

EdgeClusterAllocationStatus (schema)

Required Permissions:

Feature:

Additional Errors: