Soracom

Users

ドキュメント

グループ設定の構造と更新方法

構造 

グループ設定は以下のように各サービス (= Namespace) 配下に、複数の Key と Value が配置されます。また、各 Key 配下の Value では、様々な構造を取りえます。

{
  "configuration": {
    "NAMESPACE": {
      "KEY1": "VALUE1",
      "KEY2": ["VALUE2-1", "VALUE2-2"],
      "KEY3": { "SUBKEY": "SUBVALUE" }
    }
  }
}

更新方法 

グループ設定を更新するには、Update Group Configuration Parameters API コール にて下記のようなフォーマットのデータを PUT すると更新できます。

  • 既に同じ Key が存在する場合には上書きされます。
  • 新規の Key である場合には追記されます。

PUT /groups/{group_id}/configuration/{namespace} 

PUT するデータの body 部分:

[
  {
    "key": "KEY1",
    "value": "VALUE1"
  },
  {
    "key": "KEY2",
    "value": ["VALUE2-1", "VALUE2-2"]
  },
  {
    "key": "KEY3",
    "value": { "SUBKEY": "SUBVALUE" }
  }
]

例えば SORACOM CLI では、下記のように更新できます。

$ soracom group update_configuration --group-id GROUP-ID  \
  --namespace NAMESPACE \
  --params '[{"key":"KEY1","value":"VALUE1"},{"key":"KEY2","value":["VALUE2-1","VALUE2-2"]},{"key":"KEY3","value":{"SUBKEY":"SUBVALUE"}}]'

SORACOM CLIsoracom groups list あるいは soracom groups get --group-id <グループID> コマンドでグループ設定を確認できます。設定項目が不明な場合はユーザーコンソールで設定を変更したあとにこのコマンドで差分を確認してください。

サービスごとの設定について詳しくは、以下のページを参照してください。