アラーム状態設定 (PUT /v2/alarms/{alarm_id}/state)
指定されたアラームの状態を設定します。
{alarm_id}:対象のアラームのIDを指定します。
Request Headers
「API共通項目」を参照してください。
Request Parameter
ありません。
Request Body
state
以下のアラームの状態を設定します。
- ok
- insufficient data
- alarm
指定する際には、値をダブルクォーテーション(")で囲む必要があります。
Data Type | Cardinality |
---|---|
Enum | 1..1 |
Response Headers
ステータス
正常の場合は以下のステータスを返却します。
200:正常終了
異常の場合は、「API共通エラー情報」を参照してください。
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
None
変更後のアラームの状態。以下のいずれかの状態です。
- ok
- insufficient data
- alarm
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Enum | 1..1 | None | None |
Example of Request
例:指定したアラームの状態を"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"