基本的な使いかた: IoT SIM の速度クラスを変更する | SORACOM CLI 利用ガイド

IoT SIM の速度クラスを変更するには、soracom sims update-speed-class (Sim:updateSimSpeedClass API) を使用します。速度クラスについては、SORACOM Air for セルラーの IoT SIM の速度クラスを変更するを参照してください。

SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールするを参照してください。

あらかじめ SAM ユーザーに権限を設定してください

soracom sims update-speed-class (Sim:updateSimSpeedClass API) を実行するには、SAM ユーザーに Sim:updateSimSpeedClass API を呼び出すための権限を設定してから、soracom sims update-speed-class を実行します。権限設定について詳しくは、SAM ユーザーの権限を設定するを参照してください。

{sim_id} には、Sim:listSims API で取得した SIM ID を指定します。
{speedClass} に指定する値については、Sim:updateSimSpeedClass API を参照してください。

$ soracom sims update-speed-class --sim-id "{sim_id}" --speed-class "{speedClass}"

{
  "activeProfileId": "xxxxxxxxxxxxxxx",
  "createdTime": 1640071407905,
  "expiryAction": null,
  "expiryTime": null,
  "groupId": null,
  "imeiLock": null,
  "lastModifiedTime": 1640072905309,
  "lastPortMappingCreatedTime": null,
  "operatorId": "OPxxxxxxxxxx",
  "pcapEndTime": null,
  "pcapStartTime": null,
  "profiles": {
      :
  },
  "sessionStatus": {
      :
    "subscription": "plan01s",
      :
  },
      :
  "speedClass": "s1.4xfast",
      :
}

必須のフラグ (パラメータ) について

コマンドによっては、必須のフラグがあります。たとえば soracom sims update-speed-class では、SIM ID を指定する --sim-id と、速度クラスを指定する --speed-class が必須のフラグです。必須のフラグは、SORACOM API リファレンスで「必須」と表示されています。

必須のフラグを指定しなかったときは、以下のようなメッセージが表示されます。

$ soracom sims update-speed-class
Error: required parameter 'sim-id' is not specified
Usage:
  soracom sims update-speed-class [flags]

Flags:
      --body string          JSON string or @filename for API request body.
  -h, --help                 help for update-speed-class
      --sim-id string        SIM ID of the target SIM.
      --speed-class string

SORACOM API の場合

IoT SIM の速度クラスを SORACOM API で変更するには、Sim:updateSimSpeedClass API を使用します。

{sim_id} には、Sim:listSims API で取得した SIM ID を指定します。

$ curl -v -X POST https://api.soracom.io/v1/sims/{sim_id}/update_speed_class \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "speedClass": "s1.4xfast"
}'