システム変数設定

指定したノードペアのシステム変数の値を設定します。

必要な権限

MASTER以上のロールが必要です。

HTTPリクエスト

PUT /api/sonar/system-variables/:guid
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     -d disk_lack_action="stop" \
     -d min_free_disk_space_type="percent" \
     -d min_free_disk_space_value="10" \
     -X PUT \
     https://HOSTNAME/api/sonar/system-variables/a1b2c3d4-e5f6-7890-abcd-ef1234567890
リクエストパラメータ
パスパラメータ
キー型説明備考
guid文字列ノードペアGUID36文字
リクエスト本文パラメータ
キー必須型説明備考
disk_lack_actionO文字列ディスク枯渇時の動作
min_free_disk_space_typeO文字列ディスク残量しきい値の種別
min_free_disk_space_valueO文字列ディスク残量しきい値の値

正常応答

{}

エラー応答

必須パラメータが欠落している場合

HTTPステータスコード 400 応答

{
  "error_code": "null-argument",
  "error_msg": "guid should be not null"
}
ノードペア識別子がGUID形式でない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
ノードペアが存在しない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-argument",
  "error_msg": "node pair not found: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}