GET /api/sam/target/state/
Get information for all instances
Description
Reports the system state and metadata for all InterSystems IRIS® data platform instances monitored by SAM.
Request Example
GET http://localhost:52773/api/sam/target/state/
Parameters
cluster | Optional query parameter. Filters target instances by cluster id. |
This endpoint supports a cluster query parameter that filters the results by cluster. For example:
GET http://localhost:52773/api/sam/target/state/?cluster=2
Response Example
The response is a JSON array of JSON objects for each configured instance, such as:
[ { "instance": "172.16.6.9:52775", "name": "IRIS_primary", "description": "Primary Mirror Member", "clustername": "local", "id": 1, "clusterid": 1, "state": 0 }, { "instance": "172.16.6.8:52775", "name": "IRIS_backup", "description": "Backup Mirror Member", "clustername": "local", "id": "2", "clusterid": 1, "state": 1 }, ]
The possible values for state are:
-
-1: Unreachable
-
0: OK
-
1: Warning
-
2: Critical