Alerts

get_alert_config_global

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/global/ \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/global/, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/global/,
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/global/

グローバルレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_global

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/global/ \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/global/, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/global/,
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/global/

グローバルレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_global{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/global/{alert_id}

agent_idでグローバルレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_global{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/global/{alert_id}

グローバルレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_global{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/global/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_agent{agent_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/agent/{agent_id}

agent_idでエージェントレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
agent_id	path	integer	true	エージェントID
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_agent{agent_id}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/agent/{agent_id}

エージェントレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
agent_id	path	integer	true	エージェントID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_agent{agent_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/agent/{agent_id}/{alert_id}

agent_idおよびalert_idでエージェントレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
agent_id	path	integer	true	エージェントID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_agent{agent_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/agent/{agent_id}/{alert_id}

エージェントレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
agent_id	path	integer	true	エージェントID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_agent{agent_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/agent/{agent_id}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/agent/{agent_id}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
agent_id	path	integer	true	エージェントID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}

server_idによりサーバーレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}

サーバーレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/{alert_id}

server_idおよびalert_idによってサーバーレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/{alert_id}

サーバーレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}

server_idおよびdatabase_nameにより、データベースレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}

データベースレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/{alert_id}

server_id、database_name、およびalert_idごとにデータベースレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/{alert_id}

データベースレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}

server_id、database_name、およびschema_nameによってスキーマレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}schema{schema_name}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}

スキーマレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}

server_id、database_name、schema_name、およびalert_idごとにスキーマレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}

スキーマレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}

server_id、database_name、schema_name、およびtable_nameごとにテーブルレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
table_name	path	string	true	テーブル名
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}

テーブルレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
table_name	path	string	true	テーブル名
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}

server_id、database_name、schema_name、table_name、およびalert_idごとにテーブルレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
table_name	path	string	true	テーブル名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}

テーブルレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
table_name	path	string	true	テーブル名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
table_name	path	string	true	テーブル名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}

server_id、database_name、schema_name、およびindex_nameごとにインデックスレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
index_name	path	string	true	インデックス名
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}

インデックスレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
index_name	path	string	true	インデックス名
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}

server_id、database_name、schema_name、index_name、およびalert_idごとにインデックスレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
index_name	path	string	true	インデックス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}

インデックスレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
index_name	path	string	true	インデックス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
index_name	path	string	true	インデックス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}

server_id、database_name、schema_name、およびsequence_nameごとにシーケンスレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
sequence_name	path	string	true	シークエンス名
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name},
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}

シーケンスレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
sequence_name	path	string	true	シークエンス名
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}

server_id、database_name、schema_name、sequence_name、およびalert_idごとにシーケンスレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
sequence_name	path	string	true	シークエンス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}

シーケンスレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
sequence_name	path	string	true	シークエンス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
sequence_name	path	string	true	シークエンス名
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/ \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/,
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/

server_id、database_name、schema_name、およびfunction_nameごとにファンクションレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
function_name	path	string	true	ファンクション名
function_arguments	path	string	true	ファンクション引数のコンマ区切りリスト。
X-Auth-Token	header	string	true	承認トークン

詳細な説明

function_arguments ファンクション引数のコンマ区切りリスト。

注ファンクションの引数がない場合は、スペースを入力します

応答例

[
  {
    "id": 0,
    "alert_name": "string",
    "alert_template": 0,
    "description": "string",
    "enabled": true,
    "history_retention": 0,
    "frequency_min": 0,
    "auto_created": true,
    "template_id": "string",
    "params": [],
    "param_names": [
      "string"
    ],
    "param_types": "string",
    "params_units": [
      "string"
    ],
    "threshold_unit": "string",
    "operator": "string",
    "low_threshold_value": 0,
    "medium_threshold_value": 0,
    "high_threshold_value": 0,
    "send_email": true,
    "all_alert_enable": true,
    "email_group_id": 0,
    "low_alert_enable": true,
    "low_email_group_id": 0,
    "med_alert_enable": true,
    "med_email_group_id": 0,
    "high_alert_enable": true,
    "high_email_group_id": 0,
    "send_trap": true,
    "snmp_trap_version": 0,
    "low_send_trap": true,
    "med_send_trap": true,
    "high_send_trap": true,
    "cleared_alert_enable": true,
    "execute_script": true,
    "execute_script_on_clear": true,
    "execute_script_on_pem_server": true,
    "script_code": "string",
    "submit_to_nagios": true,
    "override_default_config": true,
    "send_notification": true,
    "low_webhook_ids": [
      0
    ],
    "med_webhook_ids": [
      0
    ],
    "high_webhook_ids": [
      0
    ],
    "cleared_webhook_ids": [
      0
    ]
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	アラートID。注このプロパティは、POST要求には適用されません。
» alert_name	string	false	none	アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。
» alert_template	integer	false	none	アラートテンプレートのID。このプロパティは、正の整数値である必要があります。注これはPOST要求の必須パラメーターです。
» description	string	false	none	なし
» enabled	boolean	false	none	このアラートが有効/無効かどうかを判断します。注 このプロパティは、POST要求の必須パラメーターです。
» history_retention	integer	false	none	このアラートの履歴を保持する日数を指定します。指定できる値は1〜99999です。 注このプロパティは、POST要求の必須パラメーターです。
» frequency_min	integer	false	none	PEMデータベースサーバーでアラートを確認する頻度を分単位で定義します。指定できる値は1〜65534です。 注このプロパティは、POST要求の必須パラメーターです。
» auto_created	boolean	false	none	アラートを自動作成するかどうかを指定します。
» template_id	string	false	none	アラートテンプレートを定義します。
» params	Query information ]	false	none	アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。
»» paramname	string	false	none	パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例
»» paramvalue	string	false	none	指定されたパラメーターの値
» param_names	[string]	false	none	パラメーターの名前を定義します。
» param_types	string	false	none	パラメーターのタイプを定義します。例 INTEGER/STRING..
» params_units	[string]	false	none	パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など
» threshold_unit	string	false	none	MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。
» operator	string	false	none	しきい値をチェックするための演算子を定義します。有効な文字列は>"および"<"です。注 このプロパティは、POST要求の必須パラメーターです。
» low_threshold_value	number	false	none	低アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» medium_threshold_value	number	false	none	中アラートをトリガーするためのしきい値。このプロパティには、有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» high_threshold_value	number	false	none	高度なアラートをトリガーするためのしきい値。任意の有効な整数/浮動小数点値を指定できます。注これはPOST要求の必須パラメーターです。
» send_email	boolean	false	none	アラートの状態が変更されたときに電子メールを送信するかどうかを決定します。
» all_alert_enable	boolean	false	none	アラートの状態が変更されたときに、パラメーター 'email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» email_group_id	integer	false	none	アラートの状態が変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» low_alert_enable	boolean	false	none	アラートの状態がLOWに設定されているときに、パラメーター'low_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» low_email_group_id	integer	false	none	アラートの状態がLOWに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» med_alert_enable	boolean	false	none	アラートの状態がMEDIUMに設定されている場合、パラメーター'medium_email_group_id'で指定されたグループにメール通知を送信するかどうかを決定します。
» med_email_group_id	integer	false	none	アラートの状態がMEDIUMに変更されたときにメール通知の送信先のメールグループを定義します。
» high_alert_enable	boolean	false	none	アラートの状態がHIGHに設定されているときに、パラメーター'high_email_group_id'で指定されたグループに電子メール通知を送信するかどうかを決定します。
» high_email_group_id	integer	false	none	アラートの状態がHIGHに変更されたときに電子メール通知の送信先の電子メールグループを定義します。
» send_trap	boolean	false	none	アラートの状態が変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» snmp_trap_version	integer	false	none	SNMPトラップバージョンを定義します。サポートされているSNMPトラップバージョンは1、2、または3です
» low_send_trap	boolean	false	none	アラートの状態がLOWに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» med_send_trap	boolean	false	none	アラートの状態がMEDIUMに変更されたときにSNMPトラップ通知を送信するかどうかを決定します。
» high_send_trap	boolean	false	none	アラートの状態がHIGHに変わったときにSNMPトラップ通知を送信するかどうかを決定します。
» cleared_alert_enable	boolean	false	none	'クリアアラート'の通知をミュートするかどうかを決定します。
» execute_script	boolean	false	none	アラートの状態がLOW/MEDIUM/HIGHに変更された場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_clear	boolean	false	none	アラートの状態がクリアされた場合に、提供されたスクリプトを実行するかどうかを決定します。
» execute_script_on_pem_server	boolean	false	none	提供されたスクリプトをPEMホストまたはエージェントがオブジェクトを監視しているホストで実行するかどうかを決定します。
» script_code	string	false	none	実行するシェルまたはバッチスクリプト。詳細については、ドキュメントをご覧ください。
» submit_to_nagios	boolean	false	none	アラートの状態が変更されたときにnagiosに通知を送信するかどうかを決定します。
» override_default_config	boolean	false	none	デフォルトのWebhook構成をオーバーライドするかどうかを決定します。
» send_notification	boolean	false	none	Webhook送信通知を有効にするかどうかを決定します。
» low_webhook_ids	[integer]	false	none	低アラートが構成されているWebhook ID
» med_webhook_ids	[integer]	false	none	中アラートが構成されているWebhook ID
» high_webhook_ids	[integer]	false	none	高アラートが構成されているWebhook ID
» cleared_webhook_ids	[integer]	false	none	クリアされたアラートが構成されているWebhook ID

列挙値

Property	Value
paramname	Exclude tables smaller than
paramname	mount point
paramname	Host IP Address
paramname	Time interval to monitor
paramname	Time since idle
paramname	Per CPU utilization (K%)

注釈

この操作には認証が必要ありません

post_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/ \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/,
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/

ファンクションレベルのAlert を作成します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
function_name	path	string	true	ファンクション名
function_arguments	path	string	true	ファンクション引数のコンマ区切りリスト。
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

詳細な説明

function_arguments ファンクション引数のコンマ区切りリスト。

注ファンクションの引数がない場合は、スペースを入力します

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}

server_id、database_name、schema_name、function_name、およびalert_idごとにファンクションレベルのAlerts を取得します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
function_name	path	string	true	ファンクション名
function_arguments	path	string	true	ファンクション引数のコンマ区切りリスト。
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

詳細な説明

function_arguments ファンクション引数のコンマ区切りリスト。

注ファンクションの引数がない場合は、スペースを入力します

応答例

{
  "id": 0,
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "auto_created": true,
  "template_id": "string",
  "params": [],
  "param_names": [
    "string"
  ],
  "param_types": "string",
  "params_units": [
    "string"
  ],
  "threshold_unit": "string",
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "send_email": true,
  "all_alert_enable": true,
  "email_group_id": 0,
  "low_alert_enable": true,
  "low_email_group_id": 0,
  "med_alert_enable": true,
  "med_email_group_id": 0,
  "high_alert_enable": true,
  "high_email_group_id": 0,
  "send_trap": true,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	成功した応答	アラートスレッドについて

注釈

この操作には認証が必要ありません

put_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}, headers = headers)

print(r.json())

const inputBody = {
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}

ファンクションレベルのAlert を更新します。

ボディパラメーター

{
  "alert_name": "string",
  "alert_template": 0,
  "description": "string",
  "enabled": true,
  "history_retention": 0,
  "frequency_min": 0,
  "operator": "string",
  "low_threshold_value": 0,
  "medium_threshold_value": 0,
  "high_threshold_value": 0,
  "all_alert_enable": true,
  "email_group_id": 1,
  "low_alert_enable": true,
  "low_email_group_id": 1,
  "med_alert_enable": true,
  "med_email_group_id": 1,
  "high_alert_enable": true,
  "high_email_group_id": 1,
  "send_trap": false,
  "snmp_trap_version": 0,
  "low_send_trap": true,
  "med_send_trap": true,
  "high_send_trap": true,
  "cleared_alert_enable": true,
  "params": [],
  "execute_script": true,
  "execute_script_on_clear": true,
  "execute_script_on_pem_server": true,
  "script_code": "string",
  "submit_to_nagios": true,
  "override_default_config": true,
  "send_notification": false,
  "low_webhook_ids": [],
  "med_webhook_ids": [],
  "high_webhook_ids": [],
  "cleared_webhook_ids": []
}

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
function_name	path	string	true	ファンクション名
function_arguments	path	string	true	ファンクション引数のコンマ区切りリスト。
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン
body	body	AlertPayload	true	なし

詳細な説明

function_arguments ファンクション引数のコンマ区切りリスト。

注ファンクションの引数がない場合は、スペースを入力します

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{alert_id}

Alert オブジェクトを削除します。

パラメーター

Name	In	Type	Required	Description
server_id	path	integer	true	サーバーID
database_name	path	string	true	データベース名
schema_name	path	string	true	スキーマ名
function_name	path	string	true	ファンクション名
function_arguments	path	string	true	ファンクション引数のコンマ区切りリスト。
alert_id	path	integer	true	アラートID
X-Auth-Token	header	string	true	承認トークン

詳細な説明

function_arguments ファンクション引数のコンマ区切りリスト。

注ファンクションの引数がない場合は、スペースを入力します

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	削除が成功しました。	None

レスポンススキーマ

注釈

この操作には認証が必要ありません