Show alarm state (GET /v2/alarms/{alarm_id}/state)
Shows the state of the specified alarm.
{alarm_id}: ID of the alarm.
Request headers
Refer to "Common API items".
Request parameters
None.
Response headers
Status
If normal, the following status is returned.
200: Normal completion
Refer to "Common API error codes" if the state is error.
Data type | Cardinality |
---|---|
Int | 1..1 |
Response elements
None
State of the current alarm. One of the following values is used.
- ok
- insufficient data
- alarm
Data type | Cardinality | Parent element | Child element |
---|---|---|---|
Enum | 1..1 | None | None |
Example of request
Example: Show the state of the specified alarm.
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x . . .' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms/078af3e0-c197-44cc-b6b6-85de5ee5d548/state'
Example of response
"alarm"