Schemas ======= プロファイル ------------ .. code:: json { "id": 0, "name": "string", "description": "string", "target_kind": "s", "published": true, "parent_id": 0, "draft_id": 0, "target_probe_configs": [ { "probe_id": 0, "probe_name": "string", "enabled": true, "interval": 0, "lifetime": 0, "default_enabled": true, "default_interval": 0, "default_lifetime": 0, "target_type": 0, "force_enabled": true } ], "target_alert_configs": [ { "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] } ] } プローブとアラート構成を含む完全なプロファイルの詳細 GET /profiles/{profile_id}によって返されます。 プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,なし name,string,false,none,なし description,string,false,none,なし target_kind,string,false,none,プロファイルのターゲットタイプサーバーの場合は's'、エージェントの場合は'a'。 published,boolean,false,none,プロファイルが公開される場合はtrue、ドラフトの場合はfalse。 parent_id,integer,false,none,親プロファイルID公開されたプロファイルの場合はnull、下書きに設定されます。 draft_id,integer,false,none,下書きプロファイルID下書きがある公開済みプロファイルにのみ存在します。 target_probe_configs,\ :ref:`[ProbeConfig <#tocs_probeconfig>` ],false,none,プロファイルに関連付けられたプローブ構成。 target_alert_configs,\ :ref:`[Alert <#tocs_alert>` ],false,none,プロファイルに関連付けられているアラート構成。 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable target_kind,s target_kind,a プロフィールドラフト -------------------- .. code:: json { "id": 0, "name": "string", "description": "string", "target_kind": "s", "published": true, "target_probe_configs": [ { "probe_id": 0, "probe_name": "string", "enabled": true, "interval": 0, "lifetime": 0, "default_enabled": true, "default_interval": 0, "default_lifetime": 0, "target_type": 0, "force_enabled": true } ], "target_alert_configs": [ { "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] } ] } ドラフトプロファイルの詳細 GET /profiles/{profile_id}/draftによって返されます。 parent_idまたはdraft_idは含まれません。 .. _プロパティ-1: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,なし name,string,false,none,なし description,string,false,none,なし target_kind,string,false,none,プロファイルのターゲットタイプサーバーの場合は's'、エージェントの場合は'a'。 published,boolean,false,none,ドラフトの場合は常にfalse。 target_probe_configs,\ :ref:`[ProbeConfig <#tocs_probeconfig>` ],false,none,ドラフトに関連付けられたプローブ構成。 target_alert_configs,\ :ref:`[Alert <#tocs_alert>` ],false,none,ドラフトに関連付けられたアラート構成。 .. _列挙値-1: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable target_kind,s target_kind,a プロフィール概要 ---------------- .. code:: json { "id": 34, "name": "Production Agents", "description": "Monitoring production agents", "target_kind": "a", "active_assignments": 0, "published": true } リスト操作のトリミングされたプロファイル表現形式プローブ/アラート構成配列なし。 .. _プロパティ-2: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,なし name,string,false,none,なし description,string,false,none,なし target_kind,string,false,none,プロファイルのターゲットタイプサーバーの場合は's'、エージェントの場合は'a'。 published,boolean,false,none,コンビニエンスフラグ ステータスが'published'の場合にtrue。 active_assignments,integer,false,none,このプロファイルに割り当てられたアクティブなサーバー/エージェントの数。 .. _列挙値-2: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable target_kind,s target_kind,a ProbeConfig ----------- .. code:: json { "probe_id": 0, "probe_name": "string", "enabled": true, "interval": 0, "lifetime": 0, "default_enabled": true, "default_interval": 0, "default_lifetime": 0, "target_type": 0, "force_enabled": true } .. _プロパティ-3: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_id,integer,false,none,なし probe_name,string,false,none,なし enabled,boolean,false,none,なし interval,integer,false,none,実行頻度分。 lifetime,integer,false,none,履歴の保持日数。 default_enabled,boolean,false,none,なし default_interval,integer,false,none,なし default_lifetime,integer,false,none,なし target_type,integer,false,none,プローブのターゲットタイプ識別子たとえば、200=サーバー、100=エージェント。 force_enabled,boolean,false,none,なし ProbeConfigUpsert ----------------- .. code:: json { "probe_id": 7, "enabled": true, "enabled_by_default": true, "execution_frequency": 0, "lifetime": 0 } プロファイルに追加または更新するプローブ構成フィールド。 .. _プロパティ-4: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_id,integer,true,none,追加/更新するプローブ識別子。 enabled,boolean,false,none,プロファイルでこのプローブを有効/無効にします。 enabled_by_default,boolean,false,none,プローブがデフォルトの有効化に従うかどうか。エイリアス 'use_default_enabled'が受け入れられます。 execution_frequency,integer,false,none,分単位のプローブ実行頻度。エイリアス'interval'が受け入れられます。 lifetime,integer,false,none,履歴の保持日数。 ProbeConfigsUpdateOnly ---------------------- .. code:: json { "changed": [ { "probe_id": 7, "enabled": true, "enabled_by_default": true, "execution_frequency": 0, "lifetime": 0 } ] } プロファイルIDで更新する場合のプローブ構成のデルタ ’changed’を使用して既存のプローブのみを変更します。このエンドポイントを介したプローブの追加はサポートされていません。 .. _プロパティ-5: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable changed,\ :ref:`[ProbeConfigUpsert <#tocs_probeconfigupsert>` ],false,none,変更する既存のプローブ構成probe_idで識別されます。 AlertChange ----------- .. code:: json { "id": 0, "name": "string", "enabled": true, "history_retention": 0, "frequency_min": 0, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "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 } プロファイルの既存のアラート構成を変更します。 .. _プロパティ-6: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,変更するアラートID。 name,string,false,none,アラート名。 enabled,boolean,false,none,なし history_retention,integer,false,none,なし frequency_min,integer,false,none,なし operator,string,false,none,なし low_threshold_value,number,false,none,なし medium_threshold_value,number,false,none,なし high_threshold_value,number,false,none,なし all_alert_enable,boolean,false,none,なし email_group_id,integer,false,none,なし low_alert_enable,boolean,false,none,なし low_email_group_id,integer,false,none,なし med_alert_enable,boolean,false,none,なし med_email_group_id,integer,false,none,なし high_alert_enable,boolean,false,none,なし high_email_group_id,integer,false,none,なし .. _列挙値-3: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable operator,> operator,< AlertDeleteRef -------------- .. code:: json { "id": 0 } 削除する既存のアラートへの参照IDのみ。 .. _プロパティ-7: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,true,none,削除するアラート構成ID。 AlertConfigsDelta ----------------- .. code:: json { "changed": [ { "id": 0, "name": "string", "enabled": true, "history_retention": 0, "frequency_min": 0, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "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 } ], "added": [ { "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": [] } ], "deleted": [ { "id": 0 } ] } プロファイル内のアラート構成のデルタ。 .. _プロパティ-8: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable changed,\ :ref:`[AlertChange <#tocs_alertchange>` ],false,none,既存のアラートを変更します。 added,\ :ref:`[AlertPayload <#tocs_alertpayload>` ],false,none,新しいアラートを追加します。必須フィールドについては、AlertPayloadを参照してください。 deleted,\ :ref:`[AlertDeleteRef <#tocs_alertdeleteref>` ],false,none,IDごとに既存のアラートを削除します。 DeleteAndReassignPayload ------------------------ .. code:: json { "old_profile_id": 42, "new_profile_id": 84 } .. _プロパティ-9: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable old_profile_id,integer,true,none,削除する既存のプロファイルID。 new_profile_id,integer,false,none,関連するサーバー/エージェントを再割り当てするための新しいプロファイルID オプショナル。 プロファイル割り当ての詳細 -------------------------- .. code:: json { "has_profile": true, "profile_id": 0, "profile_name": "string" } .. _プロパティ-10: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable has_profile,boolean,false,none,なし profile_id,integer,false,none,なし profile_name,string,false,none,なし AlertPayload ------------ .. 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,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_name,string,false,none,アラートの名前。注 このプロパティは、POST要求の必須パラメーターです。 alert_template,integer,false,none,アラートテンプレートのID。 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要求の必須パラメーターです。 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要求の必須パラメーターです。 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,'クリアアラート'の通知をミュートするかどうかを決定します。 params,\ :ref:`[AlertParams <#tocs_alertparams>` ],false,none,アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。 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を定義します。 アラート -------- .. 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] } .. _プロパティ-12: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable 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:`[AlertParams <#tocs_alertparams>` ],false,none,アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。 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 AlertParams ----------- .. code:: json { "paramname": "Exclude tables smaller than", "paramvalue": "string" } .. _プロパティ-13: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable paramname,string,false,none,パラメーターの名前。注このプロパティは、アラートテンプレートパラメーターリストに存在する必要があります。例 paramvalue,string,false,none,指定されたパラメーターの値 .. _列挙値-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%) AlertTemplateParams ------------------- .. code:: json { "param_names": "string", "param_types": "string", "params_units": "string" } .. _プロパティ-14: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable param_names,string,false,none,パラメーターの名前を定義します。 param_types,string,false,none,パラメーターのタイプを定義します。例 INTEGER/STRING.. params_units,string,false,none,パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など ProbeDependencyParams --------------------- .. code:: json { "internal_name": "string" } .. _プロパティ-15: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable internal_name,string,false,none,プローブの内部名。 AlternateServerProbeCode ------------------------ .. code:: json { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } .. _プロパティ-16: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable server_version_id,integer,false,none,"監視対象サーバーのサーバーバージョンID< tr>
server_version_idDatabase Server
10905PostgreSQL 9.5
10906PostgreSQL 9.6
11000PostgreSQL 10
11100PostgreSQL 11
11200PostgreSQL 12
11300PostgreSQL 13
20905Postgres Plus Advanced Server 9.5
20906Postgres Plus Advanced Server 9.6
21000 EDB Postgres Advanced Server 10
21100 EDB Postgres Advanced Server 11
21200 EDB Postgres Advanced Server 12
21300 EDB Postgres Advanced Server 13
" server_probe_code,string,false,none,指定されたサーバーバージョンで実行するSQLクエリー extension_version,integer,false,none,拡張機能のバージョンを指定します。拡張ターゲットタイプに有効な DeletedAlternateServerProbeCode ------------------------------- .. code:: json { "server_version_id": 0 } .. _プロパティ-17: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable server_version_id,integer,false,none,"監視対象サーバーのサーバーバージョンID< tr>
server_version_idDatabase Server
10905PostgreSQL 9.5
10906PostgreSQL 9.6
11000PostgreSQL 10
11100PostgreSQL 11
11200PostgreSQL 12
11300PostgreSQL 13
20905Postgres Plus Advanced Server 9.5
20906Postgres Plus Advanced Server 9.6
21000 EDB Postgres Advanced Server 10
21100 EDB Postgres Advanced Server 11
21200 EDB Postgres Advanced Server 12
21300 EDB Postgres Advanced Server 13
" プローブカラム -------------- .. code:: json { "pc_id": 0, "pc_unit": "string", "pc_graphable": true } .. _プロパティ-18: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable pc_id,integer,false,none,列識別子 pc_unit,string,false,none,列の単位を返します。 pc_graphable,boolean,false,none,列のデータをチャートでグラフ化できるかどうかを決定します。 ChartExportTemplate ------------------- .. code:: json { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [0], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [0], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [0], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [{}], "sel_metrics_T": [{}], "sel_metrics_C": [{}], "shared": [0], "shared_all": true } .. _プロパティ-19: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable chart_title,string,false,none,チャートのタイトル。注 このプロパティは、POST要求の必須パラメーターです。 chart_type,string,false,none,チャートカテゴリ。注 このプロパティは、POST要求の必須パラメーターです。 chart_category,string,false,none,チャートタイプ。注 このプロパティは、POST要求の必須パラメーターです。 chart_description,string,false,none,チャートの説明。注 このプロパティは、POST要求の必須パラメーターです。 reference_id,string,false,none,チャートの内部識別子。 chart_level,integer,false,none,チャートレベルを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_ext,[integer],false,none,折れ線グラフの外挿を定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_ext_metric,string,false,none,折れ線グラフの外挿メトリックを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_ext_metric_options,[integer],false,none,折れ線グラフの外挿メトリックオプションを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_ext_opt,string,false,none,折れ線グラフの外挿オプションを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_ext_val,string,false,none,折れ線グラフの外挿値を定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_extrapolated_type,string,false,none,折れ線グラフの外挿タイプを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_line_points,integer,false,none,折れ線グラフの外挿ポイントを定義します。 chart_line_span,[integer],false,none,折れ線グラフのスパンを定義します。注 このプロパティは、POST要求の必須パラメーターです。 chart_refresh,integer,false,none,チャートの更新時間 espan,integer,false,none,チャートスパン line_span,integer,false,none,チャートラインスパン sel_metrics_L,[object],false,none,折れ線グラフメトリックとそのプローブデータを定義します。 sel_metrics_T,[object],false,none,テーブルチャートメトリックとそのプローブデータを定義します。 sel_metrics_C,[object],false,none,キャパシティマネージャーチャートメトリックとそのプローブデータを定義します。 shared,[integer],false,none,チャートが共有されたロールIDを定義します。 shared_all,boolean,false,none,チャートをすべての人と共有する必要があるかどうかを決定します。 DashboardExportTemplate ----------------------- .. code:: json { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [{}], "c_charts": [{}], "shared": [0], "shared_all": true } .. _プロパティ-20: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,ダッシュボード名を定義します。注 このプロパティは、POST要求の必須パラメーターです。 descp,string,false,none,ダッシュボードの説明を提供します。 reference_id,string,false,none,ダッシュボードの内部識別子 font,string,false,none,ダッシュボードのフォントを定義します。 font_size,integer,false,none,ダッシュボードのフォントサイズを定義します。 level,integer,false,none,ダッシュボードレベルを定義します。 is_ops,boolean,false,none,ダッシュボードがops用であるかどうかを判断します。 show_title,boolean,false,none,ダッシュボードのタイトルを表示するかどうかを決定します。 design_layout,[object],false,none,ダッシュボードのデザインレイアウトデータを定義します。 c_charts,[object],false,none,依存するカスタムチャートとそのプローブデータを定義します。 shared,[integer],false,none,ダッシュボードを共有するロールIDを定義します。 shared_all,boolean,false,none,ダッシュボードをすべてのユーザーと共有する必要があるかどうかを決定します CustomDashboardExportData ------------------------- .. code:: json { "dashboards": [0] } .. _プロパティ-21: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable dashboards,[integer],false,none,ダッシュボードIDのリスト CustomDashboardExportResponseData --------------------------------- .. code:: json { "version": 1, "dashboards": [ { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [{}], "c_charts": [{}], "shared": [0], "shared_all": true } ] } .. _プロパティ-22: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,ダッシュボードエクスポートのバージョン dashboards,\ :ref:`[DashboardExportTemplate <#tocs_dashboardexporttemplate>` ],false,none,なし CustomDashboardImportPostData ----------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "skip_overwrite_chart": true, "dashboards": [ { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [{}], "c_charts": [{}], "shared": [0], "shared_all": true } ] } .. _プロパティ-23: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,ダッシュボードエクスポートのバージョン skip_overwrite,boolean,false,none,既存のチャートをスキップできるかどうかを決定します。 skip_overwrite_probe,boolean,false,none,既存の依存プローブをスキップできるかどうかを決定します。 skip_overwrite_chart,boolean,false,none,既存の依存チャートをスキップできるかどうかを決定します。 dashboards,\ :ref:`[DashboardExportTemplate <#tocs_dashboardexporttemplate>` ],false,none,なし CustomChartExportData --------------------- .. code:: json { "charts": [0] } .. _プロパティ-24: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable charts,[integer],false,none,チャートIDのリスト CustomChartExportResponseData ----------------------------- .. code:: json { "version": 1, "charts": [ { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [0], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [0], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [0], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [{}], "sel_metrics_T": [{}], "sel_metrics_C": [{}], "shared": [0], "shared_all": true } ] } .. _プロパティ-25: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,チャートエクスポートのバージョン charts,\ :ref:`[ChartExportTemplate <#tocs_chartexporttemplate>` ],false,none,なし CustomChartImportPostData ------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "charts": [ { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [0], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [0], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [0], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [{}], "sel_metrics_T": [{}], "sel_metrics_C": [{}], "shared": [0], "shared_all": true } ] } .. _プロパティ-26: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,チャートエクスポートのバージョン skip_overwrite,boolean,false,none,既存のチャートをスキップできるかどうかを決定します。 skip_overwrite_probe,boolean,false,none,既存の依存プローブをスキップできるかどうかを決定します。 charts,\ :ref:`[ChartExportTemplate <#tocs_chartexporttemplate>` ],false,none,なし AlertImportExportTemplate ------------------------- .. code:: json { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [0], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } .. _プロパティ-27: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,アラートテンプレートの名前。注 このプロパティは、POST要求の必須パラメーターです。 description,string,false,none,アラートテンプレートの説明。注 このプロパティは、POST要求の必須パラメーターです。 reference_id,string,false,none,アラートテンプレートの内部識別子 default_history_retention,integer,false,none,このタイプのアラートの履歴保持期間を日単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 object_type,integer,false,none,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 注 このプロパティは、POST要求の必須パラメーターです。 sql,string,false,none,しきい値に到達したことを示す数値を取得するためのSQLクエリー。パラメーター化される場合があります。注 このプロパティは、POST要求の必須パラメーターです。 applicable_on_server,string,false,none,テンプレートを適用する監視対象サーバーの種類を指定します。使用可能な値は、ALL、POSTGRES_SERVER、ADVANCED_SERVERです。注 このプロパティは、POST要求の必須パラメーターです。 default_check_frequency,integer,false,none,このテンプレートが定義するアラートをチェックする頻度分単位を指定します。注 このプロパティは、POST要求の必須パラメーターです。 threshold_unit,string,false,none,MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。 is_system_template,boolean,false,none,指定されたテンプレートがシステム定義であるかユーザー定義であるかを判断します。注このプロパティは、POST/PUT要求には適用されません。 is_auto_create,boolean,false,none,エージェントまたはサーバーがPEMに追加されたらすぐにアラートを作成するかどうかを決定します。 thresholds,[number],false,none,デフォルトのしきい値。しきい値配列の値は、演算子に基づいて並べ替えられた順序である必要があります。 operator,string,false,none,しきい値を比較する演算子 high_threshold_value,string,false,none,高しきい値 medium_threshold_value,string,false,none,中しきい値 low_threshold_value,string,false,none,低しきい値 info_sql,string,false,none,ダッシュボードのアラートに関する詳細情報を提供するSQLクエリーを定義します。 probes,\ :ref:`[CustomProbeImportPostData <#tocs_customprobeimportpostdata>` ],false,none,なし .. _列挙値-5: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< CustomAlertTemplateExportData ----------------------------- .. code:: json { "alert_templates": [0] } .. _プロパティ-28: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_templates,[integer],false,none,アラートテンプレートIDのリスト CustomAlertTemplateExportResponseData ------------------------------------- .. code:: json { "version": 1, "alert_templates": [ { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [0], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } ] } .. _プロパティ-29: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,アラートテンプレートのエクスポートのバージョン alert_templates,\ :ref:`[AlertImportExportTemplate <#tocs_alertimportexporttemplate>` ],false,none,なし CustomAlertTemplateImportPostData --------------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "alert_templates": [ { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [0], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } ] } .. _プロパティ-30: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,アラートテンプレートのエクスポートのバージョン skip_overwrite,boolean,false,none,既存のアラートテンプレートをスキップできるかどうかを決定します。 skip_overwrite_probe,boolean,false,none,既存の依存プローブをスキップできるかどうかを決定します。 alert_templates,\ :ref:`[AlertImportExportTemplate <#tocs_alertimportexporttemplate>` ],false,none,なし AlertTemplate ------------- .. code:: json { "name": "string", "description": "string", "object_type": 0, "param_names": ["string"], "param_types": "string", "params_units": ["string"], "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": ["string"], "threshold_unit": "string", "is_system_template": false, "is_auto_create": true, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "info_sql": "string" } .. _プロパティ-31: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,アラートテンプレートの名前。注 このプロパティは、POST要求の必須パラメーターです。 description,string,false,none,アラートテンプレートの説明。注 このプロパティは、POST要求の必須パラメーターです。 object_type,integer,false,none,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 注 このプロパティは、POST要求の必須パラメーターです。 param_names,[string],false,none,パラメーターの名前を定義します。 param_types,string,false,none,パラメーターのタイプを定義します。例 INTEGER/STRING.. params_units,[string],false,none,パラメーターに使用される単位を定義します。例 'DAYS'、'True or False'、'Hours'、'Minutes'など sql,string,false,none,しきい値に到達したことを示す数値を取得するためのSQLクエリー。パラメーター化される場合があります。注 このプロパティは、POST要求の必須パラメーターです。 applicable_on_server,string,false,none,テンプレートを適用する監視対象サーバーの種類を指定します。使用可能な値は、ALL、POSTGRES_SERVER、およびADVANCED_SERVERです。注 このプロパティは、POST要求の必須パラメーターです。 default_check_frequency,integer,false,none,このテンプレートで定義されたアラートをチェックする頻度を分単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 default_history_retention,integer,false,none,このタイプのアラートの履歴保持期間を日単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 probe_dependency_list,[string],false,none,アラートテンプレートが依存するプローブのリストを定義します。 threshold_unit,string,false,none,MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。 is_system_template,boolean,false,none,指定されたテンプレートがシステム定義であるかユーザー定義であるかを判断します。注このプロパティは、POST/PUT要求には適用されません。 is_auto_create,boolean,false,none,エージェントまたはサーバーがPEMに追加されたらすぐにアラートを作成するかどうかを決定します。注 エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 operator,string,false,none,しきい値を比較する演算子。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 low_threshold_value,number,false,none,低しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 medium_threshold_value,number,false,none,中しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 high_threshold_value,number,false,none,高しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 info_sql,string,false,none,ダッシュボードのアラートに関する詳細情報を提供するSQLクエリーを指定します。 .. _列挙値-6: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< AlertTemplatePost ----------------- .. code:: json { "name": "string", "description": "string", "object_type": 0, "params": [ { "param_types": "STRING", "param_units": "KK", "param_names": "param_1" } ], "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": [ { "internal_name": "probe_name" } ], "threshold_unit": "string", "is_system_template": false, "is_auto_create": true, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "info_sql": "string" } .. _プロパティ-32: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,アラートテンプレートの名前。注 このプロパティは、POST要求の必須パラメーターです。 description,string,false,none,アラートテンプレートの説明。注 このプロパティは、POST要求の必須パラメーターです。 object_type,integer,false,none,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 注 このプロパティは、POST要求の必須パラメーターです。 params,\ :ref:`[AlertTemplateParams <#tocs_alerttemplateparams>` ],false,none,アラートを確認するためにアラートテンプレートが使用するパラメーター/値のペアのリスト。注 アラートテンプレートには、 allパラメーターを定義する必要があります。 sql,string,false,none,しきい値に到達したことを示す数値を取得するためのSQLクエリー。パラメーター化される場合があります。注 このプロパティは、POST要求の必須パラメーターです。 applicable_on_server,string,false,none,テンプレートを適用する監視対象サーバーの種類を指定します。使用可能な値は、ALL、POSTGRES_SERVER、およびADVANCED_SERVERです。注 このプロパティは、POST要求の必須パラメーターです。 default_check_frequency,integer,false,none,このテンプレートで定義されたアラートをチェックする頻度を分単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 default_history_retention,integer,false,none,このタイプのアラートの履歴保持期間を日単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 probe_dependency_list,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,アラートテンプレートが依存するプローブのリストを定義します。 threshold_unit,string,false,none,MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。 is_system_template,boolean,false,none,指定されたテンプレートがシステム定義であるかユーザー定義であるかを判断します。注このプロパティは、POST/PUT要求には適用されません。 is_auto_create,boolean,false,none,エージェントまたはサーバーがPEMに追加されたらすぐにアラートを作成するかどうかを決定します。注 エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 operator,string,false,none,しきい値を比較する演算子。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 low_threshold_value,number,false,none,低しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 medium_threshold_value,number,false,none,中しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 high_threshold_value,number,false,none,高しきい値。エージェントおよびサーバーレベル、つまりobject_type 100および200でのみサポートされています。 info_sql,string,false,none,ダッシュボードのアラートに関する詳細情報を提供するSQLクエリーを指定します。 .. _列挙値-7: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< AlertTemplatePut ---------------- .. code:: json { "name": "string", "description": "string", "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": { "deleted": [ { "internal_name": "probe_name" } ], "added": [ { "internal_name": "probe_name" } ] }, "threshold_unit": "string", "is_system_template": false, "info_sql": "string" } .. _プロパティ-33: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,アラートテンプレートの名前。注 このプロパティは、POST要求の必須パラメーターです。 description,string,false,none,アラートテンプレートの説明。注 このプロパティは、POST要求の必須パラメーターです。 sql,string,false,none,しきい値に到達したことを示す数値を取得するためのSQLクエリー。パラメーター化される場合があります。注 このプロパティは、POST要求の必須パラメーターです。 applicable_on_server,string,false,none,テンプレートを適用する監視対象サーバーの種類を指定します。使用可能な値は、ALL、POSTGRES_SERVER、およびADVANCED_SERVERです。注 このプロパティは、POST要求の必須パラメーターです。 default_check_frequency,integer,false,none,このテンプレートで定義されたアラートをチェックする頻度を分単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 default_history_retention,integer,false,none,このタイプのアラートの履歴保持期間を日単位で定義します。注 このプロパティは、POST要求の必須パラメーターです。 probe_dependency_list,object,false,none,アラートテンプレートが依存するプローブのリストを定義します。 » deleted,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,削除するパラメーター/値のペアのリスト。 » added,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,追加するパラメーター/値のペアのリスト。 threshold_unit,string,false,none,MB/kB/秒/日/...などの、しきい値の計算に使用される単位 この値は、GUIでのみ使用されます。 is_system_template,boolean,false,none,指定されたテンプレートがシステム定義であるかユーザー定義であるかを判断します。注このプロパティは、POST/PUT要求には適用されません。 info_sql,string,false,none,ダッシュボードのアラートに関する詳細情報を提供するSQLクエリーを指定します。 .. _列挙値-8: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER AlertHistory ------------ .. code:: json { "alert_id": 0, "state": "High", "value": "string", "actual_value": 0 } .. _プロパティ-34: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_id,integer,false,none,アラートID state,string,false,none,州 value,string,false,none,ユーザーに提示できる価値 actual_value,number,false,none,状態変更時の実際の値 .. _列挙値-9: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable state,High state,Medium state,Low ServerStatus ------------ .. code:: json { "id": 0, "name": "string", "group_id": 0, "group_name": "string", "blackout": true, "status": "UP", "alerts": { "total": 0, "acknowledged": 0, "high": 0, "medium": 0, "low": 0, "high_acknowledged": 0, "medium_acknowledged": 0, "low_acknowledged": 0 }, "version": "string", "number_connections": 0, "remote_monitoring": true, "agent_id": 0, "sessions": { "last_recorded_time": 0, "sessions": [ { "database_name": "string", "procpid": 0, "usename": "string", "backend_start": 0, "xact_start": 0, "query_start": 0, "is_waiting": true, "is_idle": true, "is_idle_in_transaction": true, "is_vacuum": true, "is_autovacuum": true, "client_addr": "string", "client_port": 0, "memory_usage_mb": 0, "swap_usage_mb": 0, "cpu_usage": 0, "io_read_bytes": 0, "io_write_bytes": 0, "state": "string", "state_change": 0 } ] } } .. _プロパティ-35: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,サーバーID name,string,false,none,サーバー名 group_id,integer,false,none,データベースサーバーがユーザーに表示されるグループID group_name,string,false,none,グループ名 blackout,boolean,false,none,データベースサーバーのアラートブラックアウトのステータス status,string,false,none,サーバーのステータスはUP、DOWN、UNKNOWN、またはUNMANAGEDです。 alerts,object,false,none,データベースサーバーに構成されているアラートのリスト。アラートステータスと確認されたアラートの数を含む » total,integer,false,none,データベースサーバーに構成されているアラートの数 » acknowledged,integer,false,none,確認されたアラートの数 » high,integer,false,none,状態が「高」のアラートの数 » medium,integer,false,none,状態が「Medium」のアラートの数 » low,integer,false,none,状態が「Low」のアラートの数 » high_acknowledged,integer,false,none,状態が「高」の確認されたアラートの数 » medium_acknowledged,integer,false,none,状態が「中」の確認されたアラートの数 » low_acknowledged,integer,false,none,状態が「Low」である確認されたアラートの数 version,string,false,none,データベースサーバーの現在のバージョン number_connections,integer,false,none,データベースサーバーの接続数 remote_monitoring,boolean,false,none,データベースサーバーがpemAgentによってリモートで監視されているかどうかを判断します agent_id,integer,false,none,データベースサーバーを監視しているエージェントID sessions,object,false,none,データベースサーバーのすべてのセッション情報 » last_recorded_time,number,false,none,セッション情報の最後に記録された時間のUNIX時間 » sessions,[object],false,none,データベースサーバーのすべてのセッション情報のリスト »» database_name,string,false,none,データベース名 »» procpid,integer,false,none,プロセスID »» usename,string,false,none,ユーザー名 »» backend_start,number,false,none,セッション開始時刻のUNIX時間 »» xact_start,number,false,none,トランザクション開始時間のUNIX時間 »» query_start,number,false,none,クエリ開始時間のUNIX時間クエリが実行されている場合 »» is_waiting,boolean,false,none,セッションは待機中ですか？ »» is_idle,boolean,false,none,セッションはアイドルですか? »» is_idle_in_transaction,boolean,false,none,セッションはトランザクションでアイドル状態ですか? »» is_vacuum,boolean,false,none,これはVACUUMセッションですか？ »» is_autovacuum,boolean,false,none,これはAUTO VACUUMセッションですか? »» client_addr,string,false,none,セッションのクライアントのホストアドレス »» client_port,integer,false,none,セッションのクライアントポート »» memory_usage_mb,number,false,none,セッションのメモリ使用量MB単位ローカルに監視される場合にのみ使用可能 »» swap_usage_mb,number,false,none,セッションのスワップメモリ使用量MB単位ローカルに監視される場合にのみ使用可能 »» cpu_usage,number,false,none,セッションのCPU使用率パーセンテージローカルに監視される場合にのみ使用可能 »» io_read_bytes,number,false,none,セッションのI/O読み取りバイト単位ローカルに監視される場合にのみ使用可能 »» io_write_bytes,number,false,none,セッションのI/O書き込みバイト単位ローカルに監視される場合にのみ使用可能 »» state,string,false,none,セッションの現在の状態アイドル、アクティブ、トランザクション中のアイドルなど »» state_change,number,false,none,セッション内の最後の状態変更のUNIX時間 .. _列挙値-10: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable status,UP status,DOWN status,UNKNOWN status,UNMANAGED エージェントステータス ---------------------- .. code:: json { "id": 0, "name": "string", "group_id": 0, "group_name": "string", "blackout": true, "status": "UP", "alerts": { "total": 0, "acknowledged": 0, "high": 0, "medium": 0, "low": 0, "high_acknowledged": 0, "medium_acknowledged": 0, "low_acknowledged": 0 }, "version": "string", "processes": 0, "threads": 0, "cpu_utilization": 0, "memory_utilization": 0, "swap_utilization": 0, "disk_utilization": 0 } .. _プロパティ-36: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,エージェントID name,string,false,none,エージェント名 group_id,integer,false,none,エージェントがユーザーに表示されるグループID group_name,string,false,none,グループ名 blackout,boolean,false,none,エージェントのアラートブラックアウトを有効にするか無効にするかを決定します。 status,string,false,none,エージェントのステータスはUP、DOWN、またはUNKNOWNです alerts,object,false,none,エージェントに構成されたアラートのリスト。アラートステータスと確認されたアラートの数を含む » total,integer,false,none,エージェントに構成されたアラートの数 » acknowledged,integer,false,none,確認されたアラートの数 » high,integer,false,none,状態が「高」のアラートの数 » medium,integer,false,none,状態が「Medium」のアラートの数 » low,integer,false,none,状態が「Low」のアラートの数 » high_acknowledged,integer,false,none,状態が「高」の確認されたアラートの数 » medium_acknowledged,integer,false,none,状態が「中」の確認されたアラートの数 » low_acknowledged,integer,false,none,状態が「Low」である確認されたアラートの数 version,string,false,none,エージェントの現在のバージョン processes,integer,false,none,実行中のプロセスの数 threads,integer,false,none,実行中のすべてのプロセスのスレッド数 cpu_utilization,number,false,none,CPU使用率パーセント memory_utilization,number,false,none,メモリ使用率パーセント swap_utilization,number,false,none,スワップメモリ使用率パーセント disk_utilization,number,false,none,全体のディスク使用率パーセント .. _列挙値-11: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable status,UP status,DOWN status,UNKNOWN アラートステータス ------------------ .. code:: json { "alert_since": "string", "alert_id": 0, "alert_name": "string", "alert_state": "High", "value": "string", "object_description": "string", "server_id": 0, "agent_id": 0, "database": "string", "schema": "string", "package": "string", "object": "string", "alert_target_level": "Global", "last_processed": "string", "info": "string", "info_cols": ["string"], "info_vals": [["string"]] } .. _プロパティ-37: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_since,string,false,none,アラート状態が最後に変更されたUnix時間 alert_id,integer,false,none,アラート内部識別番号 alert_name,string,false,none,アラートの名前 alert_state,string,false,none,アラートの現在の状態。 'null'値は、アラートのアラートしきい値が現在違反していないことを示します。 value,string,false,none,アラートの現在値 object_description,string,false,none,モニタリングオブジェクトの説明/名前 server_id,integer,false,none,nullまたはサーバーのID agent_id,integer,false,none,nullまたはエージェントのID database,string,false,none,nullまたはデータベースの名前 schema,string,false,none,nullまたはスキーマ/名前空間の名前 package,string,false,none,nullまたはEDBパッケージの名前 object,string,false,none,nullまたは他の種類のオブジェクトの名前 alert_target_level,string,false,none,警戒対象レベル last_processed,string,false,none,アラートが処理されたUnix時間を表す文字列 info,string,false,none,アラートが生成された時点の情報 info_cols,[string],false,none,情報の列名の配列 info_vals,[array],false,none,テーブル形式のアラートに関連付けられた詳細情報配列の配列 .. _列挙値-12: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable alert_state,High alert_state,Medium alert_state,Low alert_target_level,Global alert_target_level,Agent alert_target_level,Server alert_target_level,Database alert_target_level,Schema alert_target_level,Table alert_target_level,Index alert_target_level,Sequence alert_target_level,Function alert_target_level,View CustomProbes ------------ .. code:: json { "probe_id": 0, "probe_name": "string", "enabled": true, "target_type": 0, "internal_name": "string", "is_system_probe": true, "any_server_version": true, "collection_method": "w", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_id": 0, "pc_name": "string", "pc_data_type": "bigint", "pc_internal_name": "string", "pc_unit": "string", "pc_col_type": "m", "pc_position": 0, "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ] } .. _プロパティ-38: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_id,integer,false,none,プローブの識別子 probe_name,string,false,none,プローブの名前 enabled,boolean,false,none,プローブがデフォルトで有効か無効かを決定します。 target_type,integer,false,none,プローブが適用されるオブジェクトのタイプを定義します。 internal_name,string,false,none,プローブの内部名を定義します。 PEMシステムは、プローブ統計を'pemdata'および'pemhistory'スキーマに保存するための内部テーブルを作成します。これらのテーブルの名前は、内部名と同じです。 is_system_probe,boolean,false,none,このプローブがユーザー定義であるかどうかを判断します。ユーザー定義プローブのこのフラグは常にfalseです。 any_server_version,boolean,false,none,このプローブはPostgresバリアントのバージョンに適用されるかどうかを判断します。詳細については、ドキュメントを参照してください。 collection_method,string,false,none,統計収集の方法を定義します。 PEMは、カスタムメイドのプローブの3つの方法SQL、WMI、またはバッチ/シェルスクリプトをサポートしています。 interval,integer,false,none,プローブが統計を収集する頻度を秒単位で定義します。10以上である必要があります lifetime,integer,false,none,履歴データの保持期間を日単位で定義します。有効な範囲は1〜365です。 'discard_history'がtrueに設定されている場合、この値は効果がありません。 discard_history,boolean,false,none,履歴データを破棄するかどうかを決定します。 'discard_history'がfalseに設定されている場合、このプローブのデータの履歴は保存されません。 platform,string,false,none,このプローブを実行できるプラットフォームを定義します。この値は、エージェントレベルのプローブにのみ適用されます。 probe_code,string,false,none,コードの定義に従って統計を収集するための SQL/Batchスクリプト/シェルスクリプト/WMIスクリプト。 probe_columns,[object],false,none,なし » pc_id,integer,false,none,列識別子 » pc_name,string,false,none,カラム名 » pc_data_type,string,false,none,列のデータ型。サポートされているデータ型は次のとおりです。