NSX-T Data Center REST API

Read the SHA monitor status

Read the SHA monitor status 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/{monitor-id}/status
Request Headers:
n/a
Query Parameters:
ShaMonitorStatusParameters+
Request Body:
n/a

Successful Response:

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

Example Response:

{ "monitor_path": "/infra/sha/monitors/esx-obsrv-stats-monitor", "status_details": { "overall_status": "NORMAL", "status_detail_per_sub_monitor": [ { "sub_monitor_id": "esx-obsrv-infra-stats-monitor", "status": "NORMAL", "status_description": "Plugin is disabled." }, { "sub_monitor_id": "esx-obsrv-datapath-traffic-stats-monitor", "status": "NORMAL", "status_description": "" } ] }, "effective_profile": { "effective_sub_monitor_configs": [ { "check_interval": 400, "resource_type": "ShaEsxObsrvInfraStatsMonitorConfig", "enable": false }, { "check_interval": 300, "resource_type": "ShaEsxObsrvDatapathTrafficStatsMonitorConfig", "enable": true } ], "effective_profile_path": "/infra/sha/monitors/esx-obsrv-stats-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" }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: