MENU

Soracom

Users

イベントハンドラーの仕組み

イベントハンドラーで使用する用語

イベントハンドラーでは以下の 3 つを設定します。ここではそれぞれの用語について説明します。詳細は、以下の各セクションをご確認ください。

  • 監視対象 - イベントハンドラーを実行する対象となるサブスクライバー、グループ、SIM、オペレーターを指定します。各対象に含まれる IMSI がそれぞれ監視の対象となります。
  • ルール - アクションを実行するかどうかを判定するルールを設定する項目です。 例えば「月の通信量が XX MiB を越したら」というようなルールを設定することで、指定されたアクションを実行します。
  • アクション - ルールで指定された条件が適用された場合に実行されるアクションを指定します。例えば、ルールが適用されたタイミングで指定のアドレスにメールを送ったり、SIM の速度クラスを変更したりできます。

監視対象

イベントハンドラーを実行する対象となるサブスクライバー、グループ、SIM、オペレーターを指定します。

  • サブスクライバー
  • グループ
  • SIM
  • オペレーター

監視対象で「サブスクライバー」を指定した場合は IMSI を選択します。同様に「グループ」を指定した場合はグループ ID を指定します。「SIM」を指定した場合は SIM ID を指定します。SIM ID については こちら をご確認ください。

ルール

アクションを実行するためのルールを設定します。例えば「月の通信量が XX MiB を越したら」というようなルールを設定することで「アクション」で指定されたアクションを実行します。 ルールタイプ一覧 で設定可能なタイプを確認してください。

ルールで使用するデータ通信量の集計は UTC (協定世界時)を基準に集計されます。

また、各ルールには再評価のタイミングを設定します。これは、アクション実行時に、次に同じルールを再評価する期間の指定となります。 例えばその月で XX MiB 使ったらアクションを実行する場合 BEGINNING_OF_NEXT_MONTH を指定しておくと、一度アクションが実行されたあとは翌月まではアクションが実行されません。

再評価を行うタイミング

再評価を行うタイミング説明
すぐに再評価(Immediately)すぐに再評価します。
翌月初(Beginning of next month)翌月初に再評価します。(協定世界時 UTC を基準)
翌日開始時(Beginning of next day)翌日開始時に再評価します。(協定世界時 UTC を基準)
1 日後(After one day)1 日後(24 時間後)に再評価する
再評価しない(Never)実行/再評価を行わない

「再評価を行うタイミングまで再実行しない」オプション

監視対象で「グループ」「SIM」「オペレーター」を選択した場合「再評価を行うタイミングまで再実行しない」オプションを有効にできます。「再評価を行うタイミングまで再実行しない」オプションを有効にすると、監視対象に含まれるいずれかのサブスクライバーのルールが適用された後、次に再評価を行うタイミングまでは監視対象に含まれる別のサブスクライバーに対してルールの評価をしません。

例: 以下のようにイベントハンドラーを設定します。

  • 監視対象: オペレーター
  • ルール: オペレーターにひもづく全 SIM の月次データ通信量合計が 100MiB を超えたら実行
  • 再評価を行うタイミング: 翌月初
  • アクション: メールを送信する

再評価を行うタイミングまで再実行しない : 有効の場合、オペレーターに紐づく SIM の月次データ通信量合計が 100MiB を超えると一度だけメールを送信します。再評価を行うタイミングで指定した翌月初まではメールは送信されません。

再評価を行うタイミングまで再実行しない : 無効の場合、オペレーターに紐づく SIM の月次データ通信量合計が 100MiB を超えると、オペレーターに紐づく各 SIM が通信を行った際にそれぞれの SIM ごとにメールが送信されます。

オフセット(分)

「再評価を行うタイミング」で設定した時間との差分を指定します(単位:分)。 たとえば「再評価を行うタイミング」で「翌月初 」を設定し、オフセット(分) で 1440(分)を設定した場合、翌月初から 1 日後に再評価を始めます。

当設定はルールとアクションに指定できます。より柔軟にイベントハンドラーの実行タイミングを設定できます。

アクション

指定されたルールが適用された場合に実行されるアクションを指定します。例えば、ルールが適用されたタイミングで指定のアドレスにメールを送ったり、SIM の速度クラスを変更したりできます。

ルールと同じようにタイプを指定します。 アクションタイプ一覧 に指定可能なタイプの一覧があります。

また、共通パラメータとして実行タイミングを指定します。

実行のタイミング

実行のタイミング説明
すぐに実行(Immediately)すぐに実行する
翌月初(Beginning of next month)翌月初に実行します。(協定世界時 UTC を基準)
翌日開始時(Beginning of next day)翌日開始時に実行します。(協定世界時 UTC を基準)
1 日後(After one day)1 日後(24 時間後)に実行する
実行しない(Never)実行しない

オフセット(分)

「実行のタイミング」で設定した時間との差分を指定します(単位:分)。 たとえば「実行のタイミング」で「翌月初 」を設定し、オフセット(分)で 1440(分)を設定した場合、翌月初から 1 日後に実行します。

当設定はルールとアクションに指定できます。より柔軟にイベントハンドラーの実行タイミングを設定できます。