ここでは、バッチ処理で複数の IoT SIM のステータスを「使用中 (active)」に変更する実行手順を示します。
ステップ 1: CSV ファイルを用意する
ステータスを「使用中 (active)」に変更する IoT SIM の一覧として SIM ID が記載された CSV ファイルを準備します。有効なリソース ID (IoT SIM の SIM ID など) を正しく入力してください。
simId
8942310XXXXXXX00000
8942310XXXXXXX00001
8942310XXXXXXX00002
CSV ファイルの要件は、利用する SORACOM API (CSV ファイルの要件 を参照してください。
と の組み合わせで指定) によって異なります。詳しくは、リソース (IoT SIM など) に対する実行順序は保証されます
ジョブを開始すると、CSV ファイルの上から順番に 1 つずつ処理されます。つまり、1 つのリソースの処理 (タスク) が終了したら、次のリソースの処理 (タスク) が開始されます。1 つのジョブで 2 つのタスクが同時に実行されることはありません。
- 1 つの CSV ファイルで指定できるリソースは、最大 10,000 件です。
- CSV ファイルの文字エンコーディングは、UTF-8 に設定してください。
ステップ 2: バッチグループを作成する
IoT SIM のステータスを「使用中 (active)」に変更するジョブを管理するためのバッチグループを作成します。「ジョブ」および「バッチグループ」については、バッチ処理の特徴 を参照してください。
ユーザーコンソール にログインし、対象の IoT SIM にあわせてカバレッジタイプを変更します。
たとえば、plan01s の IoT SIM のステータスを変更する場合は、グローバルカバレッジの表示に変更します。詳しくは、SORACOM ユーザーコンソールで表示するカバレッジタイプを変更する を参照してください。
→ → の順にクリックします。
バッチグループ画面が表示されます。
をクリックします。
以下の項目を設定します。
項目 説明 作成するバッチグループの名前を入力します。例: IoT SIM ステータス変更 01 バッチグループの説明を入力します。 をクリックします。
バッチグループが作成されます。
バッチグループを編集/削除するには
- バッチグループを編集するには、 → の順にクリックします。
- バッチグループを削除するには、 → → の順にクリックします。
ステップ 3: ジョブを開始する
IoT SIM のステータスを「使用中 (active)」に変更するジョブを作成します。1 つのバッチグループには複数のジョブを作成できます。
ジョブを実行しているときに同じ API を指定した新しいジョブを開始できません
たとえば、
で「activateSim」を指定したジョブが実行中の場合は、次のジョブの で同一の「activateSim」を指定すると、ジョブが失敗します。同一の API を利用する場合は、実行中のジョブが終了してから、新しいジョブを開始してください。複数のジョブの実行順序は保証されません
異なる API を指定したジョブは、同時に複数実行できます。ただし、複数のジョブの実行順序は保証されません。たとえば、同一の IoT SIM に対して、setSimGroup を実行するジョブと unsetSimGroup を実行するジョブを、並列で同時に実行した場合、その結果は保証されません。
バッチグループ画面でバッチグループ名をクリックします。
バッチジョブ画面が表示されます。
をクリックします。
以下の項目を設定します。
項目 説明 任意の名前を入力します。例: 「使用中 (Active)」に変更します API グループを選択します。ここでは、「SIM」を選択します。 API を選択します。ここでは、「activateSim」を選択します。 なお、
で「SIM」を選択し、 で「activateSim」を選択した場合は、Sim:activateSim API
が実行されます。ステップ 1: CSV ファイルを用意する で準備した CSV ファイルを選択します。
をクリックして、CSV ファイルがアップロードされます。
で、CSV ファイルのデータの何列目に、処理対象のデータ (例: SIM ID) が含まれるかを選択します。ここでは、「Column 1: simId」を選択します。
に、IoT SIM の SIM ID が表示されます。この表の 1 行が 1 つのタスクです。ジョブを開始すると、タスクが上から順に実行されます。
で「- Not assigned -」を選択すると、ジョブは開始できません。
を選択します。
項目 説明 1 つでもタスクが失敗すると、ジョブを中止します。失敗したあとのタスクは実行されません。 タスクが失敗しても、ジョブの実行が継続します。 をクリックします。
実行を開始したジョブはキャンセルできません。
- ジョブは 1 つのリソース (IoT SIM など。CSV の行に相当します) ごとに実行されます。順番が入れ替わったり、並列で実行されることはありません。
- 1 つのジョブで実行可能なメソッドは 1 つです。複数のメソッドを実行することはできません。
ステップ 4: ジョブの実行結果を確認する
バッチジョブ画面で、ジョブ名をクリックします。
ジョブ詳細画面が表示されます。
項目 説明 ジョブ名。 ジョブ ID。 CSV ファイルで指定したリソースに対して実行する API。ジョブを開始するときに、 と で指定します。ジョブを開始するときに で選択した項目。ジョブの実行状態 (ステータス) が表示されます。
表示 説明 PENDING ジョブの開始を待っています。 RUNNING ジョブが実行中です。 COMPLETED ジョブが終了し、すべてのタスクが成功しました。 ABORTED 1 つのタスクが失敗したためジョブを中止しました。 FAILED ジョブが終了し、すべてのタスクを実行しましたが、1 つ以上のタスクが失敗しました。 、 ジョブの開始日時と終了日時。
ジョブの実行時間はシステムの状況によって異なります
タスクの件数が同じでも、ジョブの実行時間はシステムの状況によって異なります。
(概要) タスクの実行状態 (ステータス) ごとに、タスクの件数が表示されます。
項目 説明 TOTAL タスクの件数。 SUCCESS 成功したタスクの件数。 ERROR 失敗したタスクの件数。 PENDING 実行前のタスクの件数。 (詳細) タスクの結果が一覧表示されます。
- フィルタリング条件を指定して、 をクリックすると、タスクのステータスやリソース ID でフィルタリングできます。
- をクリックすると、一覧に表示されているリソース ID を CSV ファイルでダウンロードできます。
タスクの実行に失敗したときは
タスクの実行に失敗した理由については、以下の点を確認してください。
CSV ファイルが処理できない場合の失敗:
- CSV ファイルの列名が正しいことを確認します。
- 不正な値が含まれないことを確認します。
- フォーマットが正しいことを確認します。
- 文字エンコーディングが UTF-8 になっていることを確認します。
リソースが存在しない場合の失敗:
指定したリソースのカバレッジタイプが、バッチグループを作成したカバレッジタイプと一致していることを確認します。具体的には、カバレッジタイプを変更せずに、SORACOM ユーザーコンソールで対象のリソースが存在することを確認してください。
API のレート制限による失敗
バッチ処理によって API を呼び出した場合も、レート制限 (rate limit) が適用されます。バッチ処理単体ではレート制限に抵触しない速度で処理されますが、ほかのシステムが同時に API を呼び出すと、レート制限によって失敗する可能性があります。
対応しない API を実行した場合の失敗:
バッチ処理を利用せずに API を実行すると成功することを確認します。たとえば、plan-D (D-300MB) の IoT SIM の SIM ID を指定して、
Sim:setSimToStandby API
を実行すると失敗します。これは、plan-D (D-300MB) が、「利用開始待ち (standby)」に対応していないためです。
また、失敗したタスクを再実行する場合は、ERROR や PENDING のリソース ID だけを表示したうえで、 をクリックすると、一覧に表示されているリソース ID だけを CSV ファイルでダウンロードできます。この CSV ファイルを利用して、新しいジョブを作成することが考えられます。
(詳細) でフィルタリング条件を指定して、ジョブの実行結果は自動的に削除されます
ジョブの実行結果は、作成から 32 日後に自動的に削除されます。