Soracom

Users

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

CSV ファイルの要件

ここでは、ジョブが要求する CSV ファイルについて説明します。CSV ファイルの要件は、利用する [操作] によって異なります。

[サービス] Sim (IoT SIM)

[操作] activateSim、deactivateSim、suspendSim、setSimToStandby

[サービス][操作]説明
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

[サービス][操作]説明
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

IoT SIM の名前を設定する場合は、タグの名前に name を指定します。

タグの削除、タグ名の変更はできません

タグの削除やタグ名の変更には対応していません。値を削除する場合は、タグの値を空欄に更新してください。タグ自体は削除されません。

ジョブに割り当てなかったタグは削除されません

値を更新するタグだけを割り当ててください。バッチ処理に含まれなかったタグは変更されません。

[操作] setSimGroup

[サービス][操作]説明
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

[サービス][操作]説明
SimunsetSimGroupIoT SIM を SIM グループから外します。詳しくは、Sim:unsetSimGroup API を参照してください。

例:

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

[操作] addSubscription

[サービス][操作]説明
SimaddSubscriptionIoT SIM のプロファイルにサブスクリプションを追加します。詳しくは、Sim:addSubscription API を参照してください。

例:

simId,iccid,subscription,type,enable
8942310XXXXXXX00000,8942310XXXXXXX00000,planP1,,
8942310XXXXXXX00001,8942310XXXXXXX00001,planX3,cellular,true
8942310XXXXXXX00002,8942310XXXXXXX00002,plan-US-max,cellular,true
8942310XXXXXXX00003,8942310XXXXXXX00003,planArc01,virtual,
  • simId : ジョブで処理される IoT SIM の SIM ID。
  • iccid : サブスクリプションを追加するプロファイルの ICCID。
  • subscription : 追加するサブスクリプション名。
  • type : サブスクリプションのタイプ (cellular または virtual)。省略可能。
  • enable : サブスクリプションを有効化するかどうか (true または false)。省略可能。

[サービス] VirtualPrivateGateway (VPG)

[操作] putVirtualPrivateGatewayIpAddressMapEntry

[サービス][操作]説明
VirtualPrivateGatewayputVirtualPrivateGatewayIpAddressMapEntryVPG に接続する際に、IoT 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。