Update alarm state (PUT /v2/alarms/{alarm_id}/state)
Sets the state of the specified alarm.
{alarm_id}: ID of the alarm.
Request headers
Refer to "Common API items".
Request parameters
None.
Request body
state
Sets the state of the specified alarm.
- ok
- insufficient data
- alarm
It is necessary to enclose the value with double quotation marks (").
| Data type | Cardinality |
|---|---|
| Enum | 1..1 |
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 updated alarm. One of the following states will be returned.
- ok
- insufficient data
- alarm
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Enum | 1..1 | None | None |
Example of request
Example: Update the state of the specified alarm to "alarm".
curl -X PUT -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x . . .' \
-H 'Content-Type: application/json' -d '"alarm"' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms/078af3e0-c197-44cc-b6b6-85de5ee5d548/state'
Example of response
"alarm"