Soracom

Users

ドキュメント
Home ドキュメント バッチ処理 リファレンス

CSV ファイルの要件

ここでは、ジョブが要求する CSV ファイルについて説明します。CSV ファイルの要件は、利用する SORACOM API ([API][メソッド] の組み合わせで指定) によって異なります。

[API] SIM

[メソッド] activateSim、deactivateSim、suspendSim、setSimToStandby

[API][メソッド]説明
SIMactivateSimIoT SIM のステータスを「使用中 (active)」に変更します。詳しくは、Sim:activateSim API を参照してください。
SIMdeactivateSimIoT SIM のステータスを「休止中 (inactive)」に変更します。詳しくは、Sim:deactivateSim API を参照してください。
SIMsuspendSimIoT SIM のステータスを「利用中断中 (suspended)」に変更します。詳しくは、Sim:suspendSim API を参照してください。
SIMsetSimToStandbyIoT SIM のステータスを「利用開始待ち (standby)」に変更します。詳しくは、Sim:setSimToStandby API を参照してください。

例:

simId
8942310XXXXXXX00000
8942310XXXXXXX00001
8942310XXXXXXX00002
...
  • simId : ジョブで処理される IoT SIM の SIM ID。

[メソッド] putSimTags

[API][メソッド]説明
SIMputSimTagsIoT SIM のタグを追加 / 更新します。詳しくは、Sim:putSimTags API を参照してください。

例:

simId,tagName1,tagName2
8942310XXXXXXX00000,TAG_A_0,TAG_B_0
8942310XXXXXXX00001,TAG_A_1,TAG_B_0
8942310XXXXXXX00002,TAG_A_2,TAG_B_2
...
  • simId : ジョブで処理される IoT SIM の SIM ID。

  • tagNameN : 設定するタグの名前 (例: tagName1 および tagName2)

    • 1 行目の 2 列目以降 (上の例の場合は tagName1 および tagName2) は、タグの名前として扱われます。
    • 2 行目以降の 2 列目以降 (上の例の場合は TAG_A_0 および TAG_B_0) は、IoT SIM に設定するタグの値として扱われます。

たとえば、例の CSV ファイルを利用してジョブを実行すると、SIM ID が 8942310XXXXXXX00000 のタグは、以下のようになります。

  • tagName1: TAG_A_0
  • tagName2: TAG_B_0

[メソッド] setSimGroup

[API][メソッド]説明
SIMsetSimGroupIoT SIM を SIM グループに所属させます。詳しくは、Sim:setSimGroup API を参照してください。

例:

simId,groupId
8942310XXXXXXX00000,XXXXXXXX-AAAA-BBBB-CCCC-000000000000
8942310XXXXXXX00001,XXXXXXXX-AAAA-BBBB-CCCC-000000000000
8942310XXXXXXX00002,YYYYYYYY-DDDD-EEEE-FFFF-000000000000
...
  • simId : ジョブで処理される IoT SIM の SIM ID。
  • groupId : IoT SIM を所属させる SIM グループの グループ ID。

[メソッド] unsetSimGroup

[API][メソッド]説明
SIMunsetSimGroupIoT SIM を SIM グループから外します。詳しくは、Sim:unsetSimGroup API を参照してください。

例:

simId
8942310XXXXXXX00000
8942310XXXXXXX00001
8942310XXXXXXX00002
...
  • simId : ジョブで処理される IoT SIM の SIM ID。

[API] Virtual Private Gateway

[メソッド] putVirtualPrivateGatewayIpAddressMapEntry

[API][メソッド]説明
VirtualPrivateGatewayputVirtualPrivateGatewayIpAddressMapEntryVPG に接続する際に、SIM に特定の IP アドレスを割り当てます。詳しくは、VirtualPrivateGateway:putVirtualPrivateGatewayIpAddressMapEntry API を参照してください。

例:

vpgId,ipAddress,key
XXXXXXXX-AAAA-BBBB-CCCC-000000000000,10.0.0.111,295050011111111
XXXXXXXX-AAAA-BBBB-CCCC-000000000000,10.0.0.112,295050022222222
XXXXXXXX-AAAA-BBBB-CCCC-000000000000,10.0.0.113,295050033333333
...
  • vpgId : IP アドレスを割り当てる VPG の ID。
  • ipAddress : IoT SIM に割り当てる IP アドレス。
  • key : IoT SIM の IMSI。