Soracom

Users

ドキュメント

IoT SIM のデータ通信量を確認する

IoT SIM が利用したデータ通信量は、約 5 分間隔で SORACOM プラットフォームに記録されます。記録されたデータ通信量は、以下のいずれかの方法で確認できます。確認方法によって、表示方式や表示単位、最大表示期間が異なります。

確認方法説明
SIM 詳細画面 / ダッシュボード

1 件の IoT SIM のデータ通信量をグラフで確認できます。

例: 任意の IoT SIM (1 件) の 2021 年 1 月 1 日から 45 日間のデータ通信量をグラフで確認できます。

取得開始日時: 任意の日付の 0:00 (UTC)

取得終了日時: 以下のとおりです。

表示単位最大表示期間
[1 ヶ月ごと]最大 24 か月
[1 日ごと]最大 45 日
[1 時間ごと]最大 48 時間
SORACOM CLI / SORACOM API の場合
  • soracom stats air sims get (Stats:getAirStatsOfSim API) を利用すると、1 件の IoT SIM についてデータ通信量を集計して、JSON 形式で取得できます。なお、最大取得期間は以下のとおりです。

    取得開始日時: 任意の日時

    取得終了日時: ${period} に指定した値によって、以下のように異なります。

    ${period}最大取得可能期間
    month (1 か月ごと)最大約 36 か月 (94694400 秒)
    day (1 日ごと)最大 92 日 (7948800 秒)
    minutes (もっとも細かい粒度。最短で約 5 分単位)最大 3 日 (259200 秒)
  • soracom stats air get (Stats:getAirStats API) を利用すると、1 件の IoT SIM についてデータ通信量を集計して、JSON 形式で取得できます。なお、取得期間は任意に設定できます。

    取得開始日時: 任意の日時

    取得終了日時: 任意の日時

CSV ファイル

すべての IoT SIM のデータ通信量を CSV ファイルでダウンロードできます。出力単位と最大出力期間は、以下のとおりです。

出力単位最大出力期間
[過去 6 ヶ月分 (月ごと)]最大 6 か月
[過去 90 日間分 (日ごと)]最大 90 日

例: すべての IoT SIM の 90 日前から現在までのデータ通信量を CSV ファイルでダウンロードできます。

SORACOM CLI / SORACOM API の場合

soracom stats air export (Stats:exportAirStats API) を利用すると、すべての IoT SIM について、1 か月ごとにデータ通信量を集計した CSV ファイルをダウンロードできます。

出力開始日時: 任意の日時

出力終了日時: 任意の日時

IoT SIM ごとにデータ通信量を確認する

SIM 詳細画面で確認する

当月の月間累積データ通信量を折れ線グラフで、指定した表示期間のデータ通信量を棒グラフで確認できます。

項目説明
DownloadIoT SIM ← SORACOM プラットフォームという向きのデータ通信量
UploadIoT SIM → SORACOM プラットフォームという向きのデータ通信量
  1. SORACOM ユーザーコンソール にログインし、データ通信量を確認する IoT SIM にあわせてカバレッジタイプを変更します。

    たとえば、plan01s の IoT SIM のデータ通信量を確認する場合は、グローバルカバレッジの表示に変更します。詳しくは、SORACOM ユーザーコンソールで表示するカバレッジタイプを変更する を参照してください。

  2. データ通信量を確認する IoT SIM にチェックを入れ、[詳細][通信量履歴] の順にクリックします。

    「月間累積データ使用量」と「データ使用量」がグラフで表示されます。

    なお、「データ使用量」のグラフでは、表示期間 (表示単位と表示開始日) を選択できます。

    表示単位最大表示期間
    [1 ヶ月ごと]最大 24 か月
    [1 日ごと]最大 45 日
    [1 時間ごと]最大 48 時間

    表示開始日から最大表示期間の間にデータ通信を行わなかった場合は「No Data Available」と表示されます。

  3. マウスカーソルをグラフに合わせます。

    データ通信量の詳細が表示されます。

ダッシュボードで確認する

  • 複数の IoT SIM のデータ通信量を順番に確認する場合は、ダッシュボードを表示して、表示する IoT SIM を切り替えると便利です。

  • ダッシュボードの URL には IMSI が含まれるため、SAM ユーザーと共有するときに便利です。

    例: https://console.soracom.io/#/dashboards?imsi={IMSI}&coverage_type=g

  1. SORACOM ユーザーコンソール にログインし、データ通信量を確認する IoT SIM にあわせてカバレッジタイプを変更します。

    たとえば、plan01s の IoT SIM のデータ通信量を確認する場合は、グローバルカバレッジの表示に変更します。詳しくは、SORACOM ユーザーコンソールで表示するカバレッジタイプを変更する を参照してください。

  2. 右上のユーザー名をクリックして、[ダッシュボード] をクリックします。

  3. [表示する SIM] を選択します。

    SIM 詳細画面と同じグラフが表示されます。詳しくは、SIM 詳細画面で確認する を参照してください。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、データ通信量を取得できます。

  • SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールする を参照してください。
  • SIM ID および IMSI は、soracom sims list (Sim:listSims API) で取得できます。

SIM ID を指定してデータ通信量を取得する

soracom stats air sims get (Stats:getAirStatsOfSim API) を使用します。

最大取得期間に制限があります。詳しくは、このページの先頭の表 を参照してください。

$ soracom stats air sims get --sim-id ${simId} --from ${from} --to ${to} --period ${period}

IMSI を指定してデータ通信量を取得する

soracom stats air get (Stats:getAirStats API) を使用します。

$ soracom stats air get --imsi ${imsi} --from ${from} --to ${to} --period ${period}

SIM ID を指定してデータ通信量を取得する

Stats:getAirStatsOfSim API を使用します。

最大取得期間に制限があります。詳しくは、このページの先頭の表 を参照してください。

$ curl -v -X GET "https://api.soracom.io/v1/stats/air/sims/${sim_id}?from=${from}&to=${to}&period=${period}" \
-H "X-Soracom-API-Key: ${X_SORACOM_API_KEY}" \
-H "X-Soracom-Token: ${X_SORACOM_TOKEN}"

IMSI を指定してデータ通信量を取得する

Stats:getAirStats API を使用します。

$ curl -v -X GET "https://api.soracom.io/v1/stats/air/subscribers/${imsi}?from=${from}&to=${to}&period=${period}" \
-H "X-Soracom-API-Key: ${X_SORACOM_API_KEY}" \
-H "X-Soracom-Token: ${X_SORACOM_TOKEN}"

すべての IoT SIM のデータ通信量を CSV ファイルでダウンロードする

オペレーターが所有するすべての IoT SIM のデータ通信量をカバレッジタイプごとに確認する場合や、さらに詳細なデータ通信量詳細を確認する場合は、Air データ通信量実績データ CSV ファイル をダウンロードします。

  1. SORACOM ユーザーコンソール にログインし、データ通信量を確認する IoT SIM にあわせてカバレッジタイプを変更します。

    たとえば、plan01s の IoT SIM のデータ通信量を確認する場合は、グローバルカバレッジの表示に変更します。詳しくは、SORACOM ユーザーコンソールで表示するカバレッジタイプを変更する を参照してください。

  2. 右上のユーザー名をクリックして、[ご利用料金] をクリックします。

  3. [実績データを CSV 形式でダウンロード][Air] でダウンロードするデータを選択し、[ダウンロード] をクリックします。

    Air データ通信量実績データ CSV がダウンロードされます。

対象期間にデータ通信を行わなかった場合は、ヘッダー行だけの CSV ファイルがダウンロードされます。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、Air データ通信量実績データ CSV ファイル をダウンロードできます。

  • SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールする を参照してください。
  • オペレーター ID は、soracom operator get で取得できます。
  • 対象期間にデータ通信を行わなかった場合は、ヘッダー行だけの CSV ファイルが出力されます。

soracom stats air export (Stats:exportAirStats API) を使用します。

  1. ダウンロード用の URL を取得します。

    $ soracom stats air export --operator-id ${operator_id} \
    -- body '{
      "from": ${from},
      "to": ${to},
      "period": "${period}"
    }'
    {
      "url": "https://soracom-subscriber-stats-fileoutput-g-prod...."
    }
    
  2. url で取得した URL から CSV ファイルをダウンロードします。

    $ wget -O export.csv "https://soracom-subscriber-stats-fileoutput-g-prod...."
    

タイムアウトする場合

上記の手順でタイムアウトする場合は、以下の手順でダウンロードしてください。

soracom stats air export (Stats:exportAirStats API) および soracom files get-exported (Files:getExpotedFile API) を使用します。

  1. ダウンロード用の exportedFileId を取得します。

    $ soracom stats air export --operator-id ${operator_id} --export-mode async \
    -- body '{
      "from": ${from},
      "to": ${to},
      "period": "${period}"
    }'
    {
      "exportedFileId": "fe_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "exportedFilePath": "//files/exported/fe_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    
  2. exportedFileId で示されるファイルのダウンロード用の URL を取得します。

    $ soracom files get-exported --exported-file-id ${exported_file_id}
    {
      "status": "exported",
      "url": "https://soracom-subscriber-stats-fileoutput-g-prod...."
    }
    
  3. statusexported になっていることを確認し、url で取得した URL から CSV ファイルをダウンロードします。

    $ wget -O export.csv "https://soracom-subscriber-stats-fileoutput-g-prod...."
    
  • SORACOM API を利用するには、API キーと API トークンが必要です。詳しくは、API キーと API トークンの取り扱いについて を参照してください。
  • オペレーター ID は、API キーと API トークンを取得したときに、同時に取得できます。
  • 対象期間にデータ通信を行わなかった場合は、ヘッダー行だけの CSV ファイルが出力されます。

Stats:exportAirStats API を使用します。

  1. ダウンロード用の URL を取得します。

    $ curl -v -X POST "https://api.soracom.io/v1/stats/air/operators/${operator_id}/export" \
    -H "X-Soracom-API-Key: ${X_SORACOM_API_KEY}" \
    -H "X-Soracom-Token: ${X_SORACOM_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
      "from": ${from},
      "to": ${to},
      "period": "${period}"
    }'
    {
      "url": "https://soracom-subscriber-stats-fileoutput-g-prod...."
    }
    
  2. url で取得した URL から CSV ファイルをダウンロードします。

    $ wget -O export.csv "https://soracom-subscriber-stats-fileoutput-g-prod...."
    

タイムアウトする場合

上記の手順でタイムアウトする場合は、以下の手順でダウンロードしてください。

Stats:exportAirStats API および Files:getExpotedFile API を使用します。

  1. ダウンロード用の URL を取得します。

    $ curl -v -X POST "https://api.soracom.io/v1/stats/air/operators/${operator_id}/export?export_mode=async" \
    -H "X-Soracom-API-Key: ${X_SORACOM_API_KEY}" \
    -H "X-Soracom-Token: ${X_SORACOM_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
      "from": ${from},
      "to": ${to},
      "period": "${period}"
    }'
    {
      "exportedFileId": "fe_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "exportedFilePath": "//files/exported/fe_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    
  2. exportedFileId で示されるファイルのダウンロード用の URL を取得します。

    $ curl -v -X GET "https://api.soracom.io/v1/files/exported/${exported_file_id}" \
    -H "X-Soracom-API-Key: ${X_SORACOM_API_KEY}" \
    -H "X-Soracom-Token: ${X_SORACOM_TOKEN}"
    {
      "status": "exported",
      "url": "https://soracom-subscriber-stats-fileoutput-g-prod...."
    }
    
  3. statusexported になっていることを確認し、url で取得した URL から CSV ファイルをダウンロードします。

    $ wget -O export.csv "https://soracom-subscriber-stats-fileoutput-g-prod...."