NSX-T Data Center REST API

Read Antrea cluster heartbeat config list

Paginated list of all Antrea cluster heartbeat config 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-heartbeat-config
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-heartbeat-config

Successful Response:

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

Example Response:

{ "results": [ { "report_interval": 60, "resource_type": "AntreaHeartbeatConfig", "id": "heartbeat-config", "display_name": "heartbeat-config", "path": "/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config", "relative_path": "heartbeat-config", "parent_path": "/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01", "unique_id": "cd51b604-2b51-4c3a-a646-671d6918a400", "realization_id": "cd51b604-2b51-4c3a-a646-671d6918a400", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_user": "admin", "_create_time": 1623401241169, "_last_modified_user": "admin", "_last_modified_time": 1623401241169, "_revision": 0 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: