Soracom

Users

Home ドキュメント SORACOM Air for セルラー IoT SIM を管理する

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 のタグは、以下の機能のタグとは関係ありません。
- Virtual Private Gateway (VPG) のタグ。詳しくは、VPG の設定を変更するの基本設定を参照してください。
- Lagoon 3 の Dashboard の Tag (タグ)。詳しくは、Dashboard の詳細設定を変更する (Settings) を参照してください。

IoT SIM のタグの利用例

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

タグに設定する付加情報	利用例
IoT SIM を挿入した IoT デバイスの設置場所	IoT SIM の実績データを CSV 形式でダウンロードして、IoT デバイスの設置場所ごとに実績データを集計する。タグが出力される CSV ファイルは以下のとおりです。課金詳細情報 CSV Air データ通信量実績データ CSV Beam リクエスト数実績データ CSV Funk リクエスト数実績データ CSV Funnel リクエスト数実績データ CSV Harvest Data 書き込み回数実績データ 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 のタグを設定する」といいます。

ユーザーコンソールにログインし、タグを設定する IoT SIM にあわせてカバレッジタイプを変更します。
たとえば、plan01s の IoT SIM のタグを設定する場合は、グローバルカバレッジの表示に変更します。詳しくは、SORACOM ユーザーコンソールで表示するカバレッジタイプを変更するを参照してください。
[メニュー] → [SORACOM AIR FOR セルラー] → [SIM 管理] の順にクリックします。
SIM 管理画面が表示されます。
タグを設定する IoT SIM にチェックを入れ、[詳細] → [タグ] の順にクリックします。
[＋] をクリックします。
「タグの編集」画面が表示されます。
[名前] と [値] を入力して、[保存] をクリックします。

以下の名前は、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` という値が設定されます。
`DSN`	SORACOM LTE-M Button シリーズの製造番号 (Device Serial Number) が値に設定されます。
`mailAddress`	SORACOM LTE-M Button for Enterprise で使用している IoT SIM に、送信先のメールアドレスを設定できます。

以下の名前は、SORACOM Air for セルラーが利用しています。追加、削除できません。
- name

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

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

タグの値を変更するには

タグのをクリックし、値を編集して、[保存] をクリックします。

タグを削除するには

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

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、タグを設定できます。

SORACOM CLI を利用する場合:
- タグを追加/更新するには、soracom sims put-tags を使用します。
- タグを削除するには、soracom sims delete-tag を使用します。
SORACOM API を利用する場合:
- タグを追加/更新するには、Sim:putSimTags API を使用します。
- タグを削除するには、Sim:deleteSimTag API を使用します。

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

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

SIM 管理画面で [] → [追加] の順にクリックします。
[タグ] に表示するタグの名前を入力して、[タグの表示列を追加] をクリックします。