NSX-T Data Center REST API

List the status of SHA monitors

List the status of SHA monitors on certain transport node.
This API is available when using VMware NSX or VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers).

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sha/monitors-status
Request Headers:
n/a
Query Parameters:
ShaMonitorStatusParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sha/monitors-status?transport_node_id=32e79d30-eb1d-400c-b313-503f8505c11c

Successful Response:

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

Example Response:

{ "results": [ { "monitor_path": "/infra/sha/monitors/esx-obsrv-tn-stats-file-dump-monitor", "status_details": { "overall_status": "NORMAL" }, "effective_profile": { "effective_configs": { "check_interval": 300, "file_dump_backup_count_dp_tn_stats": 1, "resource_type": "ShaEsxObsrvTnStatsFileDumpMonitorConfig", "enable": false }, "effective_profile_path": "/infra/sha/monitors/esx-obsrv-tn-stats-file-dump-monitor/profiles/default-profile" }, "transport_node_path": "/infra/sites/default/enforcement-points/default/host-transport-nodes/32e79d30-eb1d-400c-b313-503f8505c11c", "timestamp": 1707224381342, "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "monitor_path": "/infra/sha/monitors/esx-obsrv-stats-management", "status_details": { "overall_status": "NORMAL" }, "effective_profile": { "effective_configs": { "enable_esx_datapath_per_segment_stats": false, "resource_type": "ShaEsxObsrvStatsManagementConfig", "enable": true }, "effective_profile_path": "/infra/sha/monitors/esx-obsrv-stats-management/profiles/default-profile" }, "transport_node_path": "/infra/sites/default/enforcement-points/default/host-transport-nodes/32e79d30-eb1d-400c-b313-503f8505c11c", "timestamp": 1707224381342, "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, ... ] }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: