NSX-T Data Center REST API

Read Antrea cluster status list

Paginated list of all Antrea cluster status This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes-status
Request Headers:
n/a
Query Parameters:
AntreaClusterListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/cluster-control-planes-status

Successful Response:

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

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "AntreaClusterInfo", "id": "cluster01", "display_name": "2eb255f6-ce74-47fe-8fd7-ce725b977d97", "path": "/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/status", "relative_path": "status", "parent_path": "/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01", "unique_id": "2eb255f6-ce74-47fe-8fd7-ce725b977d97", "controller_status": { "status": "HEALTHY", "connected_agent_num": 2, "conditions": [ { "condition_type": "CONTROLLER_HEALTHY", "last_heartbeat_time": 1628732270000000, "status": "HEALTHY", "reason": "UP", "message": "" } ] }, "mp_adapter_status": { "status": "HEALTHY", "conditions": [ { "condition_type": "MP_ADAPTER_HEALTHY", "last_heartbeat_time": 1628732283000000, "status": "HEALTHY", "reason": "UP", "message": "" }, { "condition_type": "MP_CONNECTED", "last_heartbeat_time": 1628732283000000, "status": "HEALTHY", "reason": "CONNECTED", "message": "" } ] }, "ccp_adapter_status": { "status": "HEALTHY", "conditions": [ { "condition_type": "CCP_ADAPTER_HEALTHY", "last_heartbeat_time": 1628732275000000, "status": "HEALTHY", "reason": "UP", "message": "" } ] }, "agent_info": { "healthy_agent_num": 2, "degraded_agent_num": 0, "failed_agent_num": 0 }, "_create_user": "admin", "_create_time": 1517310677604, "_last_modified_user": "admin", "_last_modified_time": 1517310677604, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ] }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: