GET /api/sam/target/state/{id}

Get information for a specific instance

Description

Reports the system state and metadata for the target InterSystems IRIS® data platform instance.

Request Example

GET http://localhost:8080/api/sam/target/state/1

Parameters

id	Required path variable. The id of the target instance.

Response Example

{
    "name":"IRIS3",
    "description":"Local IRIS3",
    "instance":"172.16.6.9:52775",
    "clusterid":1,
    "clustername":"local",
    "urlPrefix": "/local3",
    "dashboardId": "UBE6j_IVk",
    "state":0
}

Note:

The urlPrefix and dashboardId properties were added in SAM version 2.0.

The possible values for state are:

-1: Unreachable
0: OK
1: Warning
2: Critical