イベントハンドラーで指定できるルールは以下のとおりです。
- サブスクライバーのデータ通信量が初めて記録されたら実行
- サブスクライバーの日次データ通信量が一定を超えたら実行
- サブスクライバーの月次データ通信量が一定を超えたら実行
- サブスクライバーの利用開始からの累積データ通信量が一定を超えたら実行
- サブスクライバー / IoT SIM のステータスが変更されたら実行
- サブスクライバー / IoT SIM の速度クラスが変更されたら実行
- サブスクライバー / IoT SIM の有効期限が切れたら実行
- サブスクライバーのセッションの状態が変更されたら実行
- サブスクライバー / IoT SIM が IMEI ロックにより接続失敗したら実行
- IoT SIM に紐づく全サブスクライバーの日次データ通信量合計が一定を超えたら実行
- IoT SIM に紐づく全サブスクライバーの月次データ通信量合計が一定を超えたら実行
- IoT SIM に紐づく全サブスクライバーの利用開始からの累積データ通信量合計が一定を超えたら実行
- IoT SIM にサブスクリプションが追加されたら実行
- グループ / オペレーターに紐づく全 IoT SIM の日次データ通信量合計が一定を超えたら実行
- グループ / オペレーターに紐づく全 IoT SIM の月次データ通信量合計が一定を超えたら実行
- 今月の利用料金が設定金額を超えたら実行
イベントを作成する操作については、以下のページを参照してください。
サブスクライバーのデータ通信量が初めて記録されたら実行
イベントを作成後、サブスクライバー (IMSI) が初めてデータ通信を行ったときに、アクションが実行されます。
このルールの再評価はできません
再評価ができないため、「毎日、初めてデータ通信を行ったときにアクションを実行する」といった目的では利用できません。そのようなイベントを実現するには、サブスクライバーの日次データ通信量が一定を超えたら実行 を利用して、しきい値 (MiB) に最小値の 1 を設定します。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーのデータ通信量が初めて記録されたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | 再評価を行うタイミング。このルールでは、「再評価を行わない」のみ指定できます。 |
が表示されますが、このルールでは使用できません。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberFirstTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberFirstTrafficRule",
"properties": {
"inactiveTimeoutDateConst": "NEVER"
}
}
...
}
サブスクライバーの日次データ通信量が一定を超えたら実行
サブスクライバー (IMSI) の日次データ通信量が一定を超えたときに、アクションが実行されます。
追加のサブスクリプションを契約した場合は別のルールを指定します
追加のサブスクリプションを契約 し、追加したサブスクリプションの通信量をもとにイベントを実行する場合は、IoT SIM に紐づく全サブスクライバーの日次データ通信量合計が一定を超えたら実行 を指定してください。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーの日次データ通信量が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberDailyTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberDailyTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "10",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_DAY",
"inactiveTimeoutOffsetMinutes": "5"
}
}
...
}
サブスクライバーの月次データ通信量が一定を超えたら実行
サブスクライバー (IMSI) の月次データ通信量が一定を超えたときに、アクションが実行されます。
追加のサブスクリプションを契約した場合は別のルールを指定します
追加のサブスクリプションを契約 し、追加したサブスクリプションの通信量をもとにイベントを実行する場合は、IoT SIM に紐づく全サブスクライバーの月次データ通信量合計が一定を超えたら実行 を指定してください。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーの月次データ通信量が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberMonthlyTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberMonthlyTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "1024",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_MONTH"
}
}
...
}
サブスクライバーの利用開始からの累積データ通信量が一定を超えたら実行
サブスクライバー (IMSI) の利用開始からの累積データ通信量が一定を超えたときに、アクションが実行されます。
追加のサブスクリプションを契約した場合は別のルールを指定します
追加のサブスクリプションを契約 し、追加したサブスクリプションの通信量をもとにイベントを実行する場合は、IoT SIM に紐づく全サブスクライバーの利用開始からの累積データ通信量合計が一定を超えたら実行 を指定してください。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーの利用開始からの累積データ通信量が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。なお、累積データ通信量はリセットされないため、しきい値を超えたあとは、再評価を行うタイミングで繰り返しアクションが実行されます。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberCumulativeTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberCumulativeTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "10240",
"inactiveTimeoutDateConst": "NEVER"
}
}
...
}
サブスクライバー / IoT SIM のステータスが変更されたら実行
IoT SIM のステータス が変更されたときに、アクションが実行されます。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーのステータスが変更されたら実行」または「SIM のステータスが変更されたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | 変更前の IoT SIM のステータス。変更前のステータスを限定して、アクションを実行するときに指定します。「未設定」を指定すると、任意のステータスから変更されたときに、アクションが実行されます。(*1) |
| * | 変更後の IoT SIM のステータス。変更後のステータスを限定して、アクションを実行するときに指定します。「未設定」を指定すると、任意のステータスに変更されたときに、アクションが実行されます。(*1) |
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| (*2) | 再評価を行うタイミングまで再実行しない。 |
- (*1) と の両方に「未設定」を指定すると、IoT SIM のステータスに関わらず、IoT SIM のステータスが変更されたときに、アクションが実行されます。
- (*2) で「SIM のステータスが変更されたら実行」を選択した場合のみ表示されます。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberStatusAttributeRule または SimStatusAttributeRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
- (*1)
sourceStatusとtargetStatusの両方を省略すると、IoT SIM のステータスに関わらず、IoT SIM のステータスが変更されたときに、アクションが実行されます。
例:
{
...
"ruleConfig": {
"type": "SubscriberStatusAttributeRule",
"properties": {
"sourceStatus": "ready",
"targetStatus": "active",
"inactiveTimeoutDateConst": "NEVER"
}
}
...
}
サブスクライバー / IoT SIM の速度クラスが変更されたら実行
IoT SIM の速度クラス が変更されたときに、アクションが実行されます。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーの速度クラスが変更されたら実行」または「SIM の速度クラスが変更されたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| 変更後の速度クラス * | 変更後の速度クラス。変更後の速度クラスを限定して、アクションを実行するときに指定します。「未設定」を指定すると、任意の速度クラスに変更されたときに、アクションが実行されます。 |
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| (*1) | 再評価を行うタイミングまで再実行しない。 |
- (*1) で「SIM の速度クラスが変更されたら実行」を選択した場合のみ表示されます。
変更前の速度クラスは指定できません。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberSpeedClassAttributeRule または SimSpeedClassAttributeRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberSpeedClassAttributeRule",
"properties": {
"targetSpeedClass": "s1.4xfast",
"inactiveTimeoutDateConst": "IMMEDIATELY"
}
}
...
}
変更前の速度クラスは指定できません。
サブスクライバー / IoT SIM の有効期限が切れたら実行
IoT SIM の有効期限 が切れたときに、アクションが実行されます。
IoT SIM の有効期限が切れたときにイベントのアクションで IoT SIM のステータスを変更しないでください
有効期限が切れたときに IoT SIM のステータスを変更するアクションは、SIM 有効期限変更画面 とイベントハンドラーの両方で設定できます。その両方で IoT SIM のステータスを変更するように設定した場合、動作順序は保証されません。イベントのアクションとして、有効期限が切れたときに IoT SIM のステータスを変更しないでください。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーの有効期限が切れたら実行」または「SIM の有効期限が切れたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| (*1) | 再評価を行うタイミングまで再実行しない。 |
- (*1) で「SIM の有効期限が切れたら実行」を選択した場合のみ表示されます。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberExpiredRule または SimExpiredRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberExpiredRule",
"properties": {
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_MONTH"
}
}
...
}
サブスクライバーのセッションの状態が変更されたら実行
対象の IoT SIM のセッションが オンライン または オフライン になったときに、アクションが実行されます。
申請が必要です
このルールを利用するには、セッションステータスルールの利用申請が必要です。ユースケースと想定するイベントの発生頻度を添えて、SORACOM サポート にお問い合わせください。
操作を始める前に準備が必要です (クリックして確認してください)
(1) SIM グループを作成する
イベントハンドラーの対象となる IoT SIM が所属する SIM グループを作成します。詳しくは、グループを作成する を参照してください。
(2) SIM グループに設定を投入する
作成した SIM グループに、putConfigurationParameters API によってこのイベントハンドラーを有効化する設定を投入します。
API リファレンスの Try it out 機能を利用してリクエストを送信するか、curl コマンドを利用して SORACOM API を呼び出す場合は下記のようなリクエストを送信します。
curl -X PUT --header 'Content-Type: application/json' \
--header 'X-Soracom-API-Key: <api-key>' \
--header 'X-Soracom-Token: <api-token>' \
-d '
[
{
"key": "sessionEventEnabled",
"value": true
}
]' 'https://api.soracom.io/v1/groups/<group id>/configuration/SoracomAir'
(3) SIM グループに IoT SIM を所属させる
イベントハンドラーの対象となる IoT SIM を SIM グループに所属させます。詳しくは、IoT SIM、LoRaWAN デバイス、Sigfox デバイスが所属するグループを切り替える を参照してください。
準備完了詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーのセッションの状態が変更されたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | アクションを実行するセッションイベントのタイプ。Created または Deleted のいずれかを選択します。 |
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| セッションイベントに IMEI が含まれている場合のみを対象とする場合はチェックを入れます。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberSessionStatusRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberSessionStatusRule",
"properties": {
"sessionStatus": "Created",
"inactiveTimeoutDateConst": "IMMEDIATELY",
"hasImei": true
}
}
...
}
セッション の特性を踏まえてアクションを設定してください
- セッションの状態が オンライン になる (
Createdイベントが発生する) ことは、必ずしもデバイスがデータ通信可能であることを示しません。 - 大量のデバイスが短時間のうちにセッションの確立や切断を実行した場合、イベントハンドラーが動作するまでに時間を要する場合があります。
- デバイスがセッションを切断せずに通信できない状態となった場合は、SORACOM の無通信タイマーによってセッションが切断され、オフライン になります。セッションの状態が オフライン になる (
Deletedイベントが発生する) までは、イベントハンドラーは動作しません。
サブスクライバー / IoT SIM が IMEI ロックにより接続失敗したら実行
IMEI ロック を設定した IoT SIM が、未登録の IMEI を持つデバイスで接続を試みて通信エラーになったときに、アクションが実行されます。
詳しくは、イベント一覧画面で作成する を参照してください。
で「サブスクライバーが IMEI ロックにより接続失敗したら実行」または「IoT SIM が IMEI ロックにより接続失敗したら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| (*1) | 再評価を行うタイミングまで再実行しない。 |
- (*1) で「IoT SIM が IMEI ロックにより接続失敗したら実行」を選択した場合のみ表示されます。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SubscriberImeiMismatchedRule または SimImeiMismatchedRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SubscriberImeiMismatchedRule",
"properties": {
"inactiveTimeoutDateConst": "AFTER_ONE_DAY"
}
}
...
}
IoT SIM に紐づく全サブスクライバーの日次データ通信量合計が一定を超えたら実行
IoT SIM の「日次データ通信量」が一定を超えたときに、アクションが実行されます。IoT SIM に複数のサブスクライバーが紐づく場合は、すべてのサブスクライバーの「日次データ通信量」を合計します。
詳しくは、イベント一覧画面で作成する を参照してください。
で「IoT SIM に紐づく全サブスクライバーの日次データ通信量合計が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SimDailyTotalTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SimDailyTotalTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "10",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_DAY",
"inactiveTimeoutOffsetMinutes": "5",
"runOnceAmongTarget": "true"
}
}
...
}
IoT SIM に紐づく全サブスクライバーの月次データ通信量合計が一定を超えたら実行
IoT SIM の「月次データ通信量」が一定を超えたときに、アクションが実行されます。IoT SIM に複数のサブスクライバーが紐づく場合は、すべてのサブスクライバーの「月次データ通信量」を合計します。
詳しくは、イベント一覧画面で作成する を参照してください。
で「IoT SIM に紐づく全サブスクライバーの月次データ通信量合計が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SimMonthlyTotalTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SimMonthlyTotalTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "1024",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_MONTH",
"runOnceAmongTarget": "false"
}
}
...
}
IoT SIM に紐づく全サブスクライバーの利用開始からの累積データ通信量合計が一定を超えたら実行
IoT SIM の利用開始からの「累積データ通信量」が一定を超えたときに、アクションが実行されます。IoT SIM に複数のサブスクライバーが紐づく場合は、すべてのサブスクライバーの「累積データ通信量」を合計します。
詳しくは、イベント一覧画面で作成する を参照してください。
で「IoT SIM に紐づく全サブスクライバーの利用開始からの累積データ通信量合計が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。なお、累積データ通信量はリセットされないため、しきい値を超えたあとは、再評価を行うタイミングで繰り返しアクションが実行されます。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SimCumulativeTotalTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SimCumulativeTotalTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "10240",
"inactiveTimeoutDateConst": "NEVER",
"runOnceAmongTarget": "true"
}
}
...
}
IoT SIM にサブスクリプションが追加されたら実行
追加のサブスクリプションを契約したあとで、OTA (Over The Air) の状況 (開始、成功、失敗) に応じて、アクションが実行されます。
OTA の状況と追加サブスクリプションのステータスは異なります
OTA の状況と、追加サブスクリプションのステータス (shipped、ready、active) は、以下のように対応します。
| OTA の状況 | 追加サブスクリプションのステータス |
|---|---|
| 開始 | shipped |
| 成功 | ready |
| 失敗 | - |
| - | active |
なお、追加サブスクリプションのステータスが delivered に変わったタイミングでアクションを実行することはできません。
詳しくは、イベント一覧画面で作成する を参照してください。
で「IoT SIM にサブスクリプションが追加されたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| 変化後の OTA の状況 * | 変化後の OTA の状況。OTA の状況を限定して、アクションを実行するときに指定します。
|
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。なお、累積データ通信量はリセットされないため、しきい値を超えたあとは、再評価を行うタイミングで繰り返しアクションが実行されます。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に SimSubscriptionStatusRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "SimSubscriptionStatusRule",
"properties": {
"targetOtaStatus": "started",
"inactiveTimeoutDateConst": "NEVER",
"runOnceAmongTarget": "false"
}
}
...
}
グループ / オペレーターに紐づく全 IoT SIM の日次データ通信量合計が一定を超えたら実行
グループ / オペレーターに紐づく全 IoT SIM の「日次データ通信量」の合計が一定を超えたときに、アクションが実行されます。
グループごとのデータ通信量は、IoT SIM がデータ通信を行ったときに所属しているグループに加算されます。
詳しくは、イベント一覧画面で作成する を参照してください。
で「監視対象に紐づく全 IoT SIM の日次データ通信量合計が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に DailyTotalTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "DailyTotalTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "1024",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_DAY",
"runOnceAmongTarget": "false"
}
}
...
}
グループ / オペレーターに紐づく全 IoT SIM の月次データ通信量合計が一定を超えたら実行
グループ / オペレーターに紐づく全 IoT SIM の月次データ通信量の合計が一定を超えたときに、アクションが実行されます。
グループごとのデータ通信量は、IoT SIM がデータ通信を行ったときに所属しているグループに加算されます。
詳しくは、イベント一覧画面で作成する を参照してください。
で「監視対象に紐づく全 IoT SIM の月次データ通信量合計が一定を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| * | データ通信量のしきい値。単位は MiB です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。このルールでは、「すぐに再評価」は指定できません。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 | |
| 再評価を行うタイミングまで再実行しない。 |
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に MonthlyTotalTrafficRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "MonthlyTotalTrafficRule",
"properties": {
"limitTotalTrafficMegaByte": "10240",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_MONTH",
"runOnceAmongTarget": "false"
}
}
...
}
今月の利用料金が設定金額を超えたら実行
「オペレーターの今月の利用料金」が設定金額を超えたときに、アクションが実行されます。
実際の利用料金とイベントハンドラーで評価する「オペレーターの今月の利用料金」の違い
実際の利用料金と、イベントハンドラーで評価する「オペレーターの今月の利用料金」は異なります。具体的には、実際の利用料金はサービスを利用した時点で発生しますが、「オペレーターの今月の利用料金」は定期的に集計されます。利用料金が発生してから、この集計が完了するまでに 1 日程度の時間がかかる場合があります。また、利用料金の種類によって「オペレーターの今月の利用料金」の計算に含まれるかどうかは、以下のように異なります。
| 利用料金の種類 | 計算に含まれる / 含まれない | 備考 |
|---|---|---|
| 初期費用 | 含まれない | IoT SIM を申し込んだ場合、デバイスを購入した場合、VPG をセットアップした場合など、サービスの利用を開始するときだけに発生する初期費用は、「オペレーターの今月の利用料金」の計算に含まれません。 |
| サブスクリプションの追加 / バンドルの変更 | - | 月の途中にサブスクリプションを追加したり、バンドルを変更した場合、「オペレーターの今月の利用料金」は、実際の利用料金よりも多くなります。月末の集計時には正しい金額で集計されます。 |
| 月額料金 / 日額料金 / 時間料金など、継続して発生する利用料金 | 含まれる | Napter のように、使用した月にのみ月額で発生するサービスも「月額料金」として「オペレーターの今月の利用料金」の計算に含まれます。 |
| 割引 | 含まれる | 長期利用割引 や「使用中 (active)」の plan01s の数量に応じた割引 (使用中の SIM 101 枚以上) など、さまざまな割引も計算に含まれます。 |
| クーポン | 含まれる | IoT SIM データ通信料クーポンや、SORACOM プラットフォームクーポンも計算に含まれます。つまり、利用料金からクーポンの金額が引かれた状態が「オペレーターの今月の利用料金」になります。 |
| 無料利用枠 | 含まれる | Harvest Data など一部のサービスには、無料利用枠が設定されています。この無料利用枠も計算に含まれます。 |
| 税 | 含まれる | - |
設定金額以上の利用料金の発生を防止する機能ではありません
- 設定金額以上の利用料金が発生したことが確認できたときにアクションが実行されますが、設定金額以上の利用料金の発生は防止できません。設定金額を超過した利用料金は、お客様に負担していただきます。
- 利用料金は、サービスを利用した時点で発生します。一方、利用料金が発生してから、イベントハンドラーが確認する「オペレーターの今月の利用料金」が集計されるまでに、1 日程度の時間がかかる場合があります。
詳しくは、イベント一覧画面で作成する を参照してください。
で「今月の利用料金が設定金額を超えたら実行」を選択します。
設定できる項目は、以下のとおりです。
| 項目 | 説明 |
|---|---|
| / * | 「オペレーターの今月の利用料金」のしきい値。単位は円 (日本カバレッジの場合)、または USD (グローバルカバレッジの場合) です。1～2147483647 の整数を指定します。 |
| * | 再評価を行うタイミング。 |
ルールを再評価するときのオフセット (分)。デフォルトは 0 です。0～525600 の整数を指定します。 |
が表示されますが、このルールでは効果がありません。
詳しくは、SORACOM CLI / SORACOM API で作成する を参照してください。
ruleConfig.type に MonthlyChargeRule を指定します。
ruleConfig.properties に設定できるプロパティは、以下のとおりです。
例:
{
...
"ruleConfig": {
"type": "MonthlyChargeRule",
"properties": {
"limitTotalAmount": "10000",
"inactiveTimeoutDateConst": "BEGINNING_OF_NEXT_MONTH"
}
}
...
}