Soracom

Users

ドキュメント

IoT SIM に付加情報 (タグ) を設定する

IoT SIM のタグは、IoT SIM に任意のデータをリンクさせるための Key-Value ストア (保存領域) です。1 つの IoT SIM に対して、任意の名前 (キー) と任意の値をペアで、20 個まで設定できます。

名前と値の保存可能なバイト数は以下のとおりです。

項目説明保存可能なバイト数
[名前]任意の名前 (キー)256 バイト (*1)
[値]任意の値512 バイト (*1)
  • (*1) 名前および値は、URL エンコード (パーセントエンコーディング) 後に保存されます。そのため、名前および値に入力できる見た目の内容は、保存可能なバイト数よりも小さくなります。なお、半角スペースは + ではなく %20 に置き換えられます。
IoT SIM 以外のタグについて

IoT SIM のタグの利用例

ソラコムでは、以下のような付加情報を IoT SIM のタグに設定することを想定しています。

タグに設定する付加情報利用例
IoT SIM を挿入した IoT デバイスの設置場所

IoT SIM の実績データを CSV 形式でダウンロードして、IoT デバイスの設置場所ごとに実績データを集計する。

タグが出力される CSV ファイルは以下のとおりです。

IoT SIM の管理者 / 管理部署の名前特定の管理者 / 管理部署が管理している IoT SIM だけを SIM 管理画面で表示する。
SORACOM LTE-M Button for Enterprise のメール送信先メール送信機能の送信先メールアドレスを設定する。
SORACOM LTE-M Button for Enterprise で利用する値タグに IoT SIM の管理者を設定しておき、SORACOM LTE-M Button for Enterprise の管理者の情報をメールで送信する。
メタデータサービス で利用する値IoT SIM のタグに任意の情報を設定しておき、メタデータとしてタグの値を取得したシステム側で、タグの値によって動作を変更する。
SORACOM Orbit で利用する値SORACOM プラットフォームにデータを送信するときに、IoT SIM のタグに設定した値によって異なるルールのデータ変換を行う。
イベントハンドラー で利用する値イベントハンドラーで設定した条件を満たしたときに、IoT SIM のタグに設定した値によって異なる URL にアクセスさせる。

IoT SIM のタグを設定する

IoT SIM のタグに付加情報を設定することを、「IoT SIM のタグを設定する」といいます。

新しい SIM 管理画面を使用してください

特に セカンダリサブスクライバー を利用する場合は、サブスクリプションコンテナに対応した新しい SIM 管理画面 を使用してください。従来の SIM 管理画面 では、利用できない機能があります。

  1. ユーザーコンソール にログインし、タグを設定する IoT SIM にあわせてカバレッジタイプを変更します。

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

  2. [メニュー][SIM 管理] の順にクリックします。

    SIM 管理画面が表示されます。

  3. タグを設定する IoT SIM にチェックを入れ、[詳細][タグ] の順にクリックします。

  4. [+] をクリックします。

    タグの編集画面が表示されます。

  5. [名前][値] を入力し、[保存] をクリックします。

  • 以下の名前は、SORACOM Air for セルラーが利用しています。削除しないでください。

    名前説明
    soracom.gadgets
    • SORACOM LTE-M Button for Enterprise または SORACOM LTE-M Button Plus で使用している IoT SIM に LTE-M-Button という値が設定されています。
    • GPS マルチユニットで使用している IoT SIM に GPS-Multiunit という値が設定されます。
    DSNSORACOM LTE-M Button シリーズ の製造番号 (Device Serial Number) が値に設定されます。
    mailAddressSORACOM LTE-M Buttton for Enterprise で使用している IoT SIM に、送信先のメールアドレスを設定できます。
  • 以下の名前は、SORACOM Air for セルラーが利用しています。追加、削除できません。

    • name
タグの名前は変更できません

保存したタグの名前は変更できません。名前を変更するには、一度タグを削除して設定し直してください。

タグの値を変更するには

タグの 鉛筆アイコン をクリックし、値を編集して、[保存] をクリックします。

タグを削除するには
[-] をクリックし、削除するタグの [削除] をクリックします。不要なタグをすべて削除したら、もう一度 [-] をクリックします。

SORACOM CLI / SORACOM API の場合

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

IoT SIM のタグを設定する

soracom sims put-tags (Sim:putSimTags API) を使用します。

$ soracom sims put-tags --sim-id {sim_id} \
--body '[
  {
    "tagName": "tagName",
    "tagValue": "tagValue"
  }
]'
タグの値を変更するには

再度上記のコマンドを使用してください。

タグを削除するには

soracom sims delete-tag (Sim:deleteSimTag API) を使用します。

$ soracom sims delete-tag --sim-id {sim_id} --tag-name {tag_name}
  • (*) SORACOM CLI を利用する場合は、{tag_name} は URL エンコード (パーセントエンコーディング) しないでください。

IoT SIM のタグを設定する

Sim:putSimTags API を使用します。

$ curl -v -X PUT https://api.soracom.io/v1/sims/{sim_id}/tags \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "tagName": "tagName",
    "tagValue": "tagValue"
  }
]'
タグの値を変更するには

再度 Sim:putSimTags API を使用してください。

タグを削除するには

Sim:deleteSimTag API を使用します。

$ curl -v -X DELETE https://api.soracom.io/v1/sims/{sim_id}/tags/{tag_name} \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN"
  • (*) SORACOM API を利用する場合は、{tag_name} は URL エンコード (パーセントエンコーディング) してください。

IoT SIM に設定したタグを SIM 管理画面に表示する

IoT SIM に設定したタグを、SORACOM ユーザーコンソールの SIM 管理画面で表示できます。

  1. SIM 管理画面で [設定][追加] の順にクリックします。

  2. [タグ] に表示するタグの名前を入力して、[タグの表示列を追加] をクリックします。