2.3 デバイスアラートの API

2.3.1 デバイスアラートの取得 (/api/v2/device/alarm/list)

概要

デバイスアラートのリストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/alarm/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名	型	必須	説明
dateFrom	string	No	yyyy-MM-dd 形式の開始時間
dateTo	string	No	yyyy-MM-dd 形式の終了時間
deviceId	long	No	デバイスのID
code	int	No	アラートのタイプ。10001：デバイスの盗難アラート、10002 ：ドア・ゲート強制突破アラート、10003：ドアセンサータイムアウト、10004：パスワードクラッキング、10005 ：（サポートされないアラートです。現在利用できません）、10006：サーモカメラ接続異常、20001：カメラの汚れ、20002：Non-Living アタック（非生体による認証）、20003：消防アラート、30001：デバイスオフラインアラート、40001：特徴量抽出エラー
status	int	No	アラートのステータス。0：すべて、1：アラート作動中、2：解除中、3：解除済み
page	int	No	ページ番号（デフォルトは 1）
size	int	No	ページサイズ（デフォルトは 20、最大 1000）
app_key	string	Yes	Appキー
sign	string	Yes	シグネチャ。1.3.1シグネチャ（sign）の計算の章を参照してください。
timestamp	string	Yes	タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": {
 "total": 639,
 "data": [{
 "traceId": "SGBD1566376557396gpknft",
 "alarmPhoto": "5d5d026df684640001b260f0",
 "code": 20002,
 "releaseTime": "",
 "level": 2,
 "resloveOption": 0,
 "alarmTime": "2019-08-21 16:35:57",
 "deviceId": 283,
 "deviceName": "SensePassTest",
 "deviceSn": "SGBD-b8b2201baea00d3918c49989838d81c0",
 "alarmTimeL": 1566376557395,
 "id": 378018,
 "deviceLocation": "306.Michael",
 "status": 0
 }],
 "size": 20,
 "totalPage": 32,
 "pageSize": 20,
 "pageNum": 1
 }
}

レスポンスのフィールド

パラメーター名	型	説明
total	int	総計
size	int	サイズ
data	object	データ
page_num	int	現在のページ番号
page_size	int	ページサイズ
total_page	int	ページ合計

dataフィールドの説明

パラメーター名	型	説明
id	long	アラートレコードのID
level	int	アラートのレベル。1 は通常のアラートを示し、2 は異常を示します
code	int	アラートのタイプ。10001：デバイスの盗難アラート、10002：ドア・ゲート強制突破アラート、10003：ドアセンサータイムアウト、10004：パスワードクラッキング、10005：（サポートされないアラートです。現在利用できません）、10006：サーモカメラ接続異常、20001：カメラの汚れ、20002：Non-Living アタック（非生体による認証）、20003：消防アラート、30001：デバイスオフラインアラート、40001：特徴量抽出エラー
description	string	アラートの説明
status	int	アラートのステータス。0：解除する必要がありません、1：アラート作動中、2：解除中、3：解除済み
traceId	string	デバイスが生成するアラートのシリアル番号であり、アラートの固有の識別番号です。
deviceId	long	デバイスID
deviceName	string	デバイス名
deviceSn	string	デバイスの LDID 番号
deviceLocation	string	デバイスの設置場所
alarmTime	string	アラート時間
alarmTimeL	long	アラートのタイムスタンプ（ミリ秒単位）
releaseTime	string	アラートのリリース時間
alarmPhoto	string	アラート写真
resolveOption	int	アラートの解除オプション。0：解除不要、1：デバイスエンドでの解除のみをサポート、2：リモート解除のみをサポート、3：デバイスエンドまたはリモートでの解除 0：解除不要 : 10004：パスワードクラッキング、20002：Non-Living アタック（非生体による認証）、30001：デバイスオフラインアラート、40001：特徴量抽出エラー 1：デバイスエンドでの解除のみをサポート : 10003：ドアセンサータイムアウト、10005：（サポートされないアラートです。現在利用できません）、10006：サーモカメラ接続異常、20001：カメラの汚れ、 3：デバイスエンドまたはリモートでの解除、10001：デバイスの盗難アラート、10002：ドア・ゲート強制突破アラート、20003：消防アラート
userId	long	登録者ID 。コード内でパスされます。40001
userName	string	登録者名。コード内でパスされます。40001
userType	int	登録者のタイプ。1：従業員、2：ビジター、3：拒否リストコード内でパスされます。40001

エラーレスポンスのフィールド

code	メッセージ	説明
30001	Param Invalid	無効なパラメーターです

2.3.2 デバイスアラートの解除 (/api/v2/device/alarm/disarm)

概要

オンラインデバイスにアラート解除コマンドを送信します。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/alarm/disarm

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名	型	必須	説明
traceId	string	Yes	アラートのシリアル番号
description	string	No	イベントの説明
app_key	string	Yes	Appキー
sign	string	Yes	シグネチャ。1.3.1シグネチャ（sign）の計算の章を参照してください。
timestamp	string	Yes	タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {}
}

エラーレスポンスのフィールド

code	メッセージ	エラーの説明
498	Param Invalid	リモートで解除できないアラートです（以下のアラートタイプのみ：10004：パスワードクラッキング、20002：Non-Living アタック（非生体による認証）、30001：デバイスオフラインアラート、40001：特徴量抽出エラー、10003：ドアセンサータイムアウト、10006：サーモカメラ接続異常、20001：カメラの汚れ）
620	Record non-existent Error	アラートは解除されています
620	Record non-existent Error	アラートのシリアル番号が存在しません
30001	Param Invalid	イベント説明が長すぎます
50001	RPC FAILED	リモートサービスの呼び出しに失敗しました