SORACOM Users

イベントハンドラー : 機能の説明

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

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

監視対象

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

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

なお plan01s をご利用でサブスクリプションを追加した場合、セカンダリサブスクライバのIMSI(planP1やplanX1などの追加したサブスクリプションのIMSI)は「サブスクライバ」の IMSI として指定できません。これは、セカンダリサブスクライバの SIM ステータスやグループ設定は、プライマリサブスクライバ(plan01s)とセカンダリサブスクライバ間で同期されるためです。たとえば、plan01s のステータスや速度クラスを変更した場合、追加のサブスクリプションにも適用されます。追加したサブスクリプションからの変更はできません。

プライマリサブスクライバ(plan01s)とセカンダリサブスクライバについては、サブスクリプション コンテナに関する用語をあわせてご確認ください。

ルール

アクションを実行するためのルールを設定します。例えば「月の通信量が XX MiBを越したら」というようなルールを設定することで「アクション」で指定されたアクションを実行します。

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

ルールの指定ではタイプを指定します。

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

ルールのタイプ一覧

タイプ 説明
サブスクライバの日次通信量が一定を超えたら実行
Subscriber Daily traffic
サブスクライバ(IMSI)の日のデータ通信量が一定を超えたらアクションを実行します。(*)
サブスクライバの月次通信量が一定を超えたら実行
Subscriber Monthly traffic
サブスクライバ(IMSI)の月のデータ通信量が一定を超えたらアクションを実行します。(*)
サブスクライバの利用開始からの累積データ通信量が一定を超えたら実行
Subscriber Cumulative traffic
サブスクライバ(IMSI)の利用開始からの累計データ通信量が一定を超えたらアクションを実行します。(*)
サブスクライバのステータスが変更されたら実行
Subscriber status attribute
サブスクライバ(IMSI)のステータスが変更されたらアクションを実行します。
サブスクライバの速度クラスが変更されたら実行
Subscriber speed class attribute
サブスクライバ(IMSI)の速度クラスが変更されたらアクションを実行します。
サブスクライバの有効期限が切れたら実行
Subscriber expired
サブスクライバ(IMSI)の有効期限が切れた時にアクションを実行します。
サブスクライバが IMEI ロックにより接続失敗したら実行
Subscriber IMEI mismatched
サブスクライバ(IMSI)が IMEI ロックにより接続失敗したらアクションを実行します。
サブスクライバの通信量が初めて記録されたら実行
Subscriber first traffic
当ルールを設定後、初めてデータ通信を行った時にアクションを実行します。
SIM にひもづく全サブスクリプションの日次データ通信量合計が一定を超えたら実行
Sim Daily total traffic
SIM(SIM ID)の日のデータ通信量が一定を超えたらアクションを実行します。サブスクリプションの追加を行っている場合、すべてのサブスクリプションの通信量を合計します。
SIM にひもづく全サブスクリプションの月次データ通信量合計が一定を超えたら実行
Sim Monthly total traffic
SIM(SIM ID)の月のデータ通信量が一定を超えたらアクションを実行します。サブスクリプションの追加を行っている場合、すべてのサブスクリプションの通信量を合計します。
SIM にひもづく全サブスクリプションの利用開始からの累積データ通信量合計が一定を超えたら実行
Sim Cumulative total traffic
SIM(SIM ID)の利用開始からの累計データ通信量が一定を超えたらアクションを実行します。サブスクリプションの追加を行っている場合、すべてのサブスクリプションの通信量を合計します。
SIM のステータスが変更されたら実行
Sim status attribute
SIM(SIM ID)のステータスが変更されたらアクションを実行します。
SIM の速度クラスが変更されたら実行
Sim speed class attribute
SIM(SIM ID)の速度クラスが変更されたらアクションを実行します。
SIM の有効期限が切れたら実行
Sim expired
SIM(SIM ID)の有効期限が切れた時にアクションを実行します。
SIM が IMEI ロックにより接続失敗したら実行
Sim IMEI mismatched
SIM(SIM ID)が IMEI ロックにより接続失敗したらアクションを実行します。
SIM にサブスクリプションが追加されたら実行
Sim subscription status
サブスクリプションの追加を行った場合にOTAの状況によってアクションを実行します。

再評価を行うタイミング

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

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

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

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

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

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

オフセット(分)

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

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

注意
  • ルールの評価やアクションを実施するタイミングにはタイムラグがあります。あらかじめご承知ください。

アクション

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

ルールと同じようにタイプを指定します。 また、共通パラメータとして実行タイミングを指定します。

アクションのタイプ一覧

タイプ 説明
メールを送る(Send mail) メールを送るアクション
SIM の速度クラスを変更する(Change speed class) SIMのSpeedClassを変更するアクション
オペレーターの登録メールアドレスにメールを送る(Send mail to operator) オペレーターの登録メールアドレスにメールを送るアクション
SIMの状態を使用中にする(Activation) SIMの状態をActive(使用中)にするアクション
SIMの状態を休止中にする(Deactivation) SIMの状態をInactive(休止中)にするアクション
SIMの状態を利用開始待ちにする(Standby) SIMの状態をStandby(利用開始待ち)にするアクション
plan-D, plan-K, plan-DU は Standby(利用開始待ち)がないため、当アクションを設定してもStandby(利用開始待ち)に遷移しません。また、plan-D, plan-K, plan-DU 以外で SIM を Standby(利用開始待ち)から 使用中 または 休止 状態に戻す際に、アクティベーション料金が適用される場合があります。詳しくは料金ページをご確認ください。
指定の URL にリクエストを送る(Execute web request) 指定のURLにリクエストをするアクション
AWS Lambdaを呼び出す(Invoke AWS Lambda) AWS Lambdaを呼び出すアクション
注意
  • SIMの状態を利用開始待ちにする(Standby)アクションの場合、SIM を Standby(利用開始待ち)から 使用中 または 休止 状態に戻す際に、アクティベーション料金が適用される場合があります。詳しくは料金ページをご確認ください。
  • SIMの状態を利用開始待ちにする場合は、再評価のタイミングにご注意ください。繰り返し実行される場合状態を戻す度に料金が発生するため、適宜 inactiveTimeoutDateConst に「再評価を行わない」を指定するなどしてください。
注意

通知の送信元メールアドレスは以下の通りです。迷惑メールなどに分類されないようご注意ください。

  • グローバルカバレッジ: no-reply@soracom.io
  • 日本カバレッジ: no-reply@soracom.jp

実行のタイミング

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

オフセット(分)

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

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

注意
  • ルールの評価やアクションを実施するタイミングにはタイムラグがあります。あらかじめご承知ください。

参考

pagetop