Alerts
======
get\_\ *alert_config_global*
----------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を取得します。
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_global*
-----------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-1:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-1:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-1:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_global*\ {alert_id}
----------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を取得します。
.. _パラメーター-2:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-2:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_global*\ {alert_id}
----------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-3:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-3:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-2:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_global*\ {alert_id}
-------------------------------------------
**コードサンプル**
.. code:: shell
# You can also use wget
curl -X DELETE https://PEM-SERVER-IP/api/v14/alert/config/global/{alert_id} \
-H X-Auth-Token: string
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-4:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. _応答-4:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-3:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_agent*\ {agent_id}
---------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を取得します。
.. _パラメーター-5:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
agent_id,path,integer,true,エージェントID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-5:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-4:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-1:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_agent*\ {agent_id}
----------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-6:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
agent_id,path,integer,true,エージェントID
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-6:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-5:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_agent*\ {agent_id}\_{alert_id}
---------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を取得します。
.. _パラメーター-7:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
agent_id,path,integer,true,エージェントID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-7:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_agent*\ {agent_id}\_{alert_id}
---------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-8:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
agent_id,path,integer,true,エージェントID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-8:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-6:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_agent*\ {agent_id}\_{alert_id}
------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-9:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
agent_id,path,integer,true,エージェントID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. _応答-9:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-7:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}
-----------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を取得します。
.. _パラメーター-10:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-10:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-8:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-2:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}
------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-11:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-11:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-9:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\_{alert_id}
-----------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-12:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-12:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\_{alert_id}
-----------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-13:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-13:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-10:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\_{alert_id}
--------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-14:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. _応答-14:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-11:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}
----------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-15:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-15:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-12:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-3:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}
-----------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-16:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-16:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-13:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\_{alert_id}
----------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-17:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-17:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\_{alert_id}
----------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-18:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-18:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-14:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\_{alert_id}
-------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-19:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
alert_id,path,integer,true,アラートID
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. _応答-19:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-15:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}
-----------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-20:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
schema_name,path,string,true,スキーマ名
X-Auth-Token,header,string,true,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-20:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-16:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-4:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}
------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-21:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
server_id,path,integer,true,サーバーID
database_name,path,string,true,データベース名
schema_name,path,string,true,スキーマ名
X-Auth-Token,header,string,true,承認トークン
body,body,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-21:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-17:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\_{alert_id}
-----------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-22:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-22:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\_{alert_id}
-----------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-23:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-23:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-18:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\_{alert_id}
--------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-24:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. _応答-24:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-19:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *table*\ {table_name}
----------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-25:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-25:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-20:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-5:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *table*\ {table_name}
-----------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-26:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-26:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-21:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *table*\ {table_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-27:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-27:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *table*\ {table_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-28:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-28:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-22:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *table*\ {table_name}\_{alert_id}
-------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-29:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. _応答-29:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-23:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *index*\ {index_name}
----------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-30:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-30:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-24:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-6:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *index*\ {index_name}
-----------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-31:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-31:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-25:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *index*\ {index_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-32:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-32:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *index*\ {index_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-33:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-33:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-26:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *index*\ {index_name}\_{alert_id}
-------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-34:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. _応答-34:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-27:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *sequence*\ {sequence_name}
----------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-35:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-35:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-28:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-7:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *sequence*\ {sequence_name}
-----------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-36:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-36:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-29:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *sequence*\ {sequence_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-37:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-37:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *sequence*\ {sequence_name}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-38:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
**応答例**
.. _応答-38:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-30:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *sequence*\ {sequence_name}\_{alert_id}
-------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-39:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
**応答例**
.. _応答-39:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-31:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *function*\ {function_name}\ *args*\ {function_arguments}\_
------------------------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-40:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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** ファンクション引数のコンマ区切りリスト。
注ファンクションの引数がない場合は、スペースを入力します
**応答例**
.. raw:: html
.. code:: json
[
{
"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
]
}
]
.. raw:: html
.. _応答-40:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,Inline
.. _レスポンススキーマ-32:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
ステータスコード **200**
.. csv-table::
:header: Name,Type,Required,Restrictions,Description
:widths: 12,8,8,8,12
:align: left
:class: longtable
*anonymous*,\ :ref:`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,\ :ref:`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
.. _列挙値-8:
列挙値
''''''
.. csv-table::
:header: Property,Value
:widths: 25,25
:align: left
:class: longtable
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%)
.. Note::
この操作には認証が必要ありません
post\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *function*\ {function_name}\ *args*\ {function_arguments}\_
-------------------------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を作成します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-41:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
.. _詳細な説明-1:
詳細な説明
''''''''''
**function_arguments** ファンクション引数のコンマ区切りリスト。
注ファンクションの引数がない場合は、スペースを入力します
**応答例**
.. _応答-41:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-33:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
get\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *function*\ {function_name}\ *args*\ {function_arguments}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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``
を取得します。
.. _パラメーター-42:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
.. _詳細な説明-2:
詳細な説明
''''''''''
**function_arguments** ファンクション引数のコンマ区切りリスト。
注ファンクションの引数がない場合は、スペースを入力します
**応答例**
.. raw:: html
.. code:: json
{
"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
]
}
.. raw:: html
.. _応答-42:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,成功した応答,:ref:`アラートスレッドについて<アラートスレッドについて>`
.. Note::
この操作には認証が必要ありません
put\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *function*\ {function_name}\ *args*\ {function_arguments}\_{alert_id}
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` を更新します。
**ボディパラメーター**
.. code:: json
{
"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": []
}
.. _パラメーター-43:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,:ref:`AlertPayload` ,true,なし
.. _詳細な説明-3:
詳細な説明
''''''''''
**function_arguments** ファンクション引数のコンマ区切りリスト。
注ファンクションの引数がない場合は、スペースを入力します
**応答例**
.. _応答-43:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ステータス200,None
.. _レスポンススキーマ-34:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません
delete\_\ *alert_config_server*\ {server_id}\ *database*\ {database_name}\ *schema*\ {schema_name}\ *function*\ {function_name}\ *args*\ {function_arguments}\_{alert_id}
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
**コードサンプル**
.. code:: shell
# 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
.. code:: python
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())
.. code:: javascript
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`` オブジェクトを削除します。
.. _パラメーター-44:
パラメーター
^^^^^^^^^^^^
.. csv-table::
:header: Name,In,Type,Required,Description
:widths: 11,7,7,7,17
:align: left
:class: longtable
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,承認トークン
.. _詳細な説明-4:
詳細な説明
''''''''''
**function_arguments** ファンクション引数のコンマ区切りリスト。
注ファンクションの引数がない場合は、スペースを入力します
**応答例**
.. _応答-44:
応答
^^^^
.. csv-table::
:header: Status,Meaning,Description,Schema
:widths: 15,12,12,20
:align: left
:class: longtable
200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,削除が成功しました。,None
.. _レスポンススキーマ-35:
レスポンススキーマ
^^^^^^^^^^^^^^^^^^
.. Note::
この操作には認証が必要ありません