Schemas
=======

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": []
   }

プロパティ
^^^^^^^^^^

.. 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
     ]
   }

.. _プロパティ-1:

プロパティ
^^^^^^^^^^

.. 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,"しきい値をチェックするための演算子を定義します。有効な文字列は>""および""&lt;""です。注 このプロパティは、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"
   }

.. _プロパティ-2:

プロパティ
^^^^^^^^^^

.. 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,指定されたパラメーターの値

列挙値
''''''

.. 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"
   }

.. _プロパティ-3:

プロパティ
^^^^^^^^^^

.. 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"
   }

.. _プロパティ-4:

プロパティ
^^^^^^^^^^

.. 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
   }

.. _プロパティ-5:

プロパティ
^^^^^^^^^^

.. 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<table class=""model""><thead><tr><th>server_version_id</th><th>Database Server</th></tr></thead><thead /> <tbody><tr><td>10905</td><td>PostgreSQL 9.5</td></tr><tr><td>10906</td><td>PostgreSQL 9.6</td></tr ><tr><td>11000</td><td>PostgreSQL 10</td></tr><tr><td>11100</td><td>PostgreSQL 11</td></tr>< tr><td>11200</td><td>PostgreSQL 12</td></tr><tr><td>11300</td><td>PostgreSQL 13</td></tr><tr> <td>20905</td><td>Postgres Plus Advanced Server 9.5</td></tr><tr><td>20906</td><td>Postgres Plus Advanced Server 9.6</td></tr ><tr><td>21000</td><td> EDB Postgres Advanced Server 10</td></tr><tr><td>21100</td><td> EDB Postgres Advanced Server 11</td ></tr><tr><td>21200 </td><td> EDB Postgres Advanced Server 12</td></tr><tr><td>21300 </td><td> EDB Postgres Advanced Server 13</td></tr></tbody></table>"
  server_probe_code,string,false,none,指定されたサーバーバージョンで実行するSQLクエリー
  extension_version,integer,false,none,拡張機能のバージョンを指定します。拡張ターゲットタイプに有効な

DeletedAlternateServerProbeCode
-------------------------------

.. code:: json

   {
     "server_version_id": 0
   }

.. _プロパティ-6:

プロパティ
^^^^^^^^^^

.. 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<table class=""model""><thead><tr><th>server_version_id</th><th>Database Server</th></tr></thead><thead /> <tbody><tr><td>10905</td><td>PostgreSQL 9.5</td></tr><tr><td>10906</td><td>PostgreSQL 9.6</td></tr ><tr><td>11000</td><td>PostgreSQL 10</td></tr><tr><td>11100</td><td>PostgreSQL 11</td></tr>< tr><td>11200</td><td>PostgreSQL 12</td></tr><tr><td>11300</td><td>PostgreSQL 13</td></tr><tr> <td>20905</td><td>Postgres Plus Advanced Server 9.5</td></tr><tr><td>20906</td><td>Postgres Plus Advanced Server 9.6</td></tr ><tr><td>21000</td><td> EDB Postgres Advanced Server 10</td></tr><tr><td>21100</td><td> EDB Postgres Advanced Server 11</td ></tr><tr><td>21200 </td><td> EDB Postgres Advanced Server 12</td></tr><tr><td>21300 </td><td> EDB Postgres Advanced Server 13</td></tr></tbody></table>"

プローブカラム
--------------

.. code:: json

   {
     "pc_id": 0,
     "pc_unit": "string",
     "pc_graphable": true
   }

.. _プロパティ-7:

プロパティ
^^^^^^^^^^

.. 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
   }

.. _プロパティ-8:

プロパティ
^^^^^^^^^^

.. 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
   }

.. _プロパティ-9:

プロパティ
^^^^^^^^^^

.. 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
     ]
   }

.. _プロパティ-10:

プロパティ
^^^^^^^^^^

.. 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
       }
     ]
   }

.. _プロパティ-11:

プロパティ
^^^^^^^^^^

.. 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
       }
     ]
   }

.. _プロパティ-12:

プロパティ
^^^^^^^^^^

.. 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
     ]
   }

.. _プロパティ-13:

プロパティ
^^^^^^^^^^

.. 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
       }
     ]
   }

.. _プロパティ-14:

プロパティ
^^^^^^^^^^

.. 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
       }
     ]
   }

.. _プロパティ-15:

プロパティ
^^^^^^^^^^

.. 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"
       }
     ]
   }

.. _プロパティ-16:

プロパティ
^^^^^^^^^^

.. 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,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 <ul><li>システム全体のアラートテンプレートは<b>50</b>です。</li><li>エージェントに適用されるアラートテンプレートは<b>100</b>です。</li> <li>管理対象サーバーに適用されるアラートテンプレートは<b>200</b>です。</li><li>特定の監視対象サーバーのデータベースに適用されるアラートテンプレートは<b>300</b>です。 </li><li>管理対象サーバーの特定のデータベースのスキーマに適用されるアラートテンプレートは<b>400</b>です。</li><li>特定のスキーマのテーブルに適用されるアラートテンプレート</li><li>監視対象サーバー上のデータベースの特定のスキーマのインデックスに適用されるアラートテンプレートは<b>600</b>です。 >.</li><li>監視対象サーバー上のデータベースの特定のスキーマのシーケンスに適用できるアラートテンプレートは<b>700</b>です。</li><li>に適用できるアラートテンプレート監視対象サーバー上のデータベースの特定のスキーマのファンクションは<b>800</b>です。</li></ul>注 このプロパティは、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,なし

.. _列挙値-1:

列挙値
''''''

.. 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,&lt;

CustomAlertTemplateExportData
-----------------------------

.. code:: json

   {
     "alert_templates": [
       0
     ]
   }

.. _プロパティ-17:

プロパティ
^^^^^^^^^^

.. 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"
           }
         ]
       }
     ]
   }

.. _プロパティ-18:

プロパティ
^^^^^^^^^^

.. 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"
           }
         ]
       }
     ]
   }

.. _プロパティ-19:

プロパティ
^^^^^^^^^^

.. 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"
   }

.. _プロパティ-20:

プロパティ
^^^^^^^^^^

.. 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,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 <ul><li>システム全体のアラートテンプレートは<b>50</b>です。</li><li>エージェントに適用されるアラートテンプレートは<b>100</b>です。</li> <li>管理対象サーバーに適用されるアラートテンプレートは<b>200</b>です。</li><li>特定の監視対象サーバーのデータベースに適用されるアラートテンプレートは<b>300</b>です。 </li><li>管理対象サーバーの特定のデータベースのスキーマに適用されるアラートテンプレートは<b>400</b>です。</li><li>特定のスキーマのテーブルに適用されるアラートテンプレート</li><li>監視対象サーバー上のデータベースの特定のスキーマのインデックスに適用されるアラートテンプレートは<b>600</b>です。 >.</li><li>監視対象サーバー上のデータベースの特定のスキーマのシーケンスに適用できるアラートテンプレートは<b>700</b>です。</li><li>に適用できるアラートテンプレート監視対象サーバー上のデータベースの特定のスキーマのファンクションは<b>800</b>です。</li></ul>注 このプロパティは、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クエリーを指定します。

.. _列挙値-2:

列挙値
''''''

.. 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,&lt;

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"
   }

.. _プロパティ-21:

プロパティ
^^^^^^^^^^

.. 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,このアラートテンプレートを適用するオブジェクトのタイプを定義します。 <ul><li>システム全体のアラートテンプレートは<b>50</b>です。</li><li>エージェントに適用されるアラートテンプレートは<b>100</b>です。</li> <li>管理対象サーバーに適用されるアラートテンプレートは<b>200</b>です。</li><li>特定の監視対象サーバーのデータベースに適用されるアラートテンプレートは<b>300</b>です。 </li><li>管理対象サーバーの特定のデータベースのスキーマに適用されるアラートテンプレートは<b>400</b>です。</li><li>特定のスキーマのテーブルに適用されるアラートテンプレート</li><li>監視対象サーバー上のデータベースの特定のスキーマのインデックスに適用されるアラートテンプレートは<b>600</b>です。 >.</li><li>監視対象サーバー上のデータベースの特定のスキーマのシーケンスに適用できるアラートテンプレートは<b>700</b>です。</li><li>に適用できるアラートテンプレート監視対象サーバー上のデータベースの特定のスキーマのファンクションは<b>800</b>です。</li></ul>注 このプロパティは、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クエリーを指定します。

.. _列挙値-3:

列挙値
''''''

.. 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,&lt;

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"
   }

.. _プロパティ-22:

プロパティ
^^^^^^^^^^

.. 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クエリーを指定します。

.. _列挙値-4:

列挙値
''''''

.. 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
   }

.. _プロパティ-23:

プロパティ
^^^^^^^^^^

.. 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,状態変更時の実際の値

.. _列挙値-5:

列挙値
''''''

.. 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
         }
       ]
     }
   }

.. _プロパティ-24:

プロパティ
^^^^^^^^^^

.. 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時間

.. _列挙値-6:

列挙値
''''''

.. 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
   }

.. _プロパティ-25:

プロパティ
^^^^^^^^^^

.. 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,全体のディスク使用率パーセント

.. _列挙値-7:

列挙値
''''''

.. 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"
       ]
     ]
   }

.. _プロパティ-26:

プロパティ
^^^^^^^^^^

.. 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,テーブル形式のアラートに関連付けられた詳細情報配列の配列

.. _列挙値-8:

列挙値
''''''

.. 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
       }
     ]
   }

.. _プロパティ-27:

プロパティ
^^^^^^^^^^

.. 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,プローブが適用されるオブジェクトのタイプを定義します。 <ul><li>target_type <b>100</b>のプローブは、エージェントの統計を収集します。</li><li>target_type <b>200</b>のプローブは、収集を担当します。 </li><li>target_type <b>300</b>のプローブは、データベースの統計を収集します。</li><li>target_type <b>400<のプローブ/b>は、スキーマの統計を収集します。</li><li>target_type <b>500</b>のプローブは、テーブルの統計を収集します。</li><li>次のプローブtarget_type <b>600</b>は、インデックスの統計を収集します。</li><li>target_type <b>700</b>のプローブは、シーケンスの統計を収集します。</li> <li>target_type <b>800</b>のプローブは、ファンクションの統計を収集します。</li><li>target_type <b>900</b>のプローブは、ファンクションの統計を収集します。 view.</li><li>target_type <b>1000</b>のプローブは、エクステンの統計を収集します。 </li></ul>
  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、またはバッチ/シェルスクリプトをサポートしています。 <ul><li>'w'はWMIスクリプトを表します。このタイプのスクリプトはWindowsプラットフォームにのみ適用され、target_typeは<b>100</b>エージェント用です。</li><li>'b'はバッチ/シェルスクリプトを表します。このスクリプトの'target_type'は常に<b>100</b>エージェントです。このスクリプトは、 Windowsではバッチスクリプトとして、他のプラットフォームではシェルスクリプトとして動作します。</li><li>'s'はSQLスクリプトの略です。 'target_type'は常に <b>200</b>サーバー、 <b>300</b>データベース、 <b>400</b>スキーマ、 <b>500</b>です。テーブル、 <b>600</b>インデックス、 <b>700</b>シーケンス、 <b>800</b>ファンクション、または <b>900</b> view)、または<b>1000</b>拡張機能。 </li></ul>
  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,コードの定義に従って統計を収集するための<b> SQL/Batchスクリプト/シェルスクリプト/WMIスクリプト</b>。
  probe_columns,[object],false,none,なし
  » pc_id,integer,false,none,列識別子
  » pc_name,string,false,none,カラム名
  » pc_data_type,string,false,none,列のデータ型。サポートされているデータ型は次のとおりです。<ul><ul>bigint</ul><ul>char</ul><ul>10進数</ul><ul>倍精度</ul><ul>整数</ul><ul >数値</ul><ul>実数</ul><ul>テキスト</ul><ul>text\[]</ul><ul>timestamp</ul><ul>timestamptz</ul>< /ul>
  » pc_internal_name,string,false,none,列の内部名を返します。
  » pc_unit,string,false,none,列の単位を返します。
  » pc_col_type,string,false,none,列を内部テーブルの主キーの一部として返すか、否か。 'k'はキー列を表し、'm'はメンバー/ノーマル列を表します。
  » pc_position,integer,false,none,内部テーブルの列の位置を返します。
  » pc_graphable,boolean,false,none,列のデータをチャートにグラフ化できるかどうかを決定します。
  » pc_calc_pit,boolean,false,none,サーバーがこの列のメトリックデータのポイントインタイムを計算するかどうかを決定します。
  » pc_pit_default,boolean,false,none,メトリックをデフォルトでポイントインタイムで保存するかどうかを決定します。詳細については、ドキュメントの'Custom Probes'セクションを参照してください。
  alternate_code,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,なし

.. _列挙値-9:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  collection_method,w
  collection_method,b
  collection_method,s
  platform,unix
  platform,windows
  pc_data_type,bigint
  pc_data_type,char
  pc_data_type,decimal
  pc_data_type,double precision
  pc_data_type,integer
  pc_data_type,numeric
  pc_data_type,real
  pc_data_type,text
  pc_data_type,text\[]
  pc_data_type,timestamp
  pc_data_type,timestamptz
  pc_col_type,m
  pc_col_type,k

CustomProbeExportData
---------------------

.. code:: json

   {
     "probes": [
       0
     ]
   }

.. _プロパティ-28:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  probes,[integer],false,none,カスタムプローブのプローブIDのリスト

CustomProbeImportData
---------------------

.. code:: json

   {
     "version": 1,
     "skip_overwrite": true,
     "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,プローブエクスポートのバージョン
  skip_overwrite,boolean,false,none,既存のプローブをスキップできるかどうかを決定します。
  probes,\ :ref:`[CustomProbeImportPostData <#tocs_customprobeimportpostdata>` ],false,none,なし

CustomProbeImportPostData
-------------------------

.. code:: json

   {
     "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

  *anonymous*,:ref:`CustomProbePostData<CustomProbePostData>` ,false,none,なし

そして

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  *anonymous*,object,false,none,なし
  » internal_name,string,false,none,プローブがエクスポートされたシステムからのプローブの内部名

CustomProbePostData
-------------------

.. code:: json

   {
     "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
       }
     ]
   }

.. _プロパティ-31:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  probe_name,string,false,none,プローブの名前
  collection_method,string,false,none,統計収集の方法を定義します。 PEMは、カスタムメイドのプローブの3つの方法SQL、WMI、またはバッチ/シェルスクリプトをサポートしています。 <ul><li>'w'はWMIスクリプトを表します。このタイプのスクリプトはWindowsプラットフォームにのみ適用され、target_typeは<b>100</b>エージェント用です。</li><li>'b'はバッチ/シェルスクリプトを表します。このスクリプトの'target_type'は常に<b>100</b>エージェントです。このスクリプトは、 Windowsではバッチスクリプトとして、他のプラットフォームではシェルスクリプトとして動作します。</li><li>'s'はSQLスクリプトの略です。 'target_type'は常に <b>200</b>サーバー、 <b>300</b>データベース、 <b>400</b>スキーマ、 <b>500</b>です。テーブル、 <b>600</b> インデックス、 <b>700</b> シーケンス、 <b>800</b> ファンクション、 <b>900</b> ビュー)または<b>1000</b>拡張子。</li></ul>
  enabled,boolean,false,none,プローブがデフォルトで有効/無効かどうかを決定します。
  target_type,integer,false,none,プローブが適用されるオブジェクトのタイプを定義します。 <ul><li>target_type <b>100</b>のプローブは、エージェントの統計を収集します。</li><li>target_type <b>200</b>のプローブは、収集を担当します。 </li><li>target_type <b>300</b>のプローブは、データベースの統計を収集します。</li><li>target_type <b>400<のプローブ/b>は、スキーマの統計を収集します。</li><li>target_type <b>500</b>のプローブは、テーブルの統計を収集します。</li><li>次のプローブtarget_type <b>600</b>は、インデックスの統計を収集します。</li><li>target_type <b>700</b>のプローブは、シーケンスの統計を収集します。</li> <li>target_type <b>800</b>のプローブは、ファンクションの統計を収集します。</li><li>target_type <b>900</b>のプローブは、ファンクションの統計を収集します。 view.</li><li>target_type <b>1000</b>のプローブは、エクステンの統計を収集します。 </li></ul>
  any_server_version,boolean,false,none,このプローブはPostgresバリアントのバージョンに適用されるかどうかを判断します。詳細については、ドキュメントを参照してください。
  any_extension_version,boolean,false,none,このプローブは拡張バリアントのバージョンに適用されるかどうかを判断します。詳細については、ドキュメントを参照してください。
  extension_name,string,false,none,拡張機能の名前。<ul>有効な名前は次のとおりです。 <b>edbspl</b> 、 <b>plpgsql</b> 、 <b>hstore</b> 、 <b>pldbgapi</b> 、 <b> edb_dblink_oci</b> 、 <b>edb_dblink_libpq</b> 、 <b>sslutils</b> .</ul>
  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,コードの定義ごとに統計を収集するための<b> SQL/Batchスクリプト/シェルスクリプト/WMIスクリプト</b>。
  probe_columns,[object],false,none,なし
  » pc_name,string,false,none,カラム名
  » pc_data_type,string,false,none,列のデータ型。サポートされているデータ型は次のとおりです。<ul><ul>bigint</ul><ul>char</ul><ul>10進数</ul><ul>倍精度</ul><ul>整数</ul><ul >数値</ul><ul>実数</ul><ul>テキスト</ul><ul>text\[]</ul><ul>timestamp</ul><ul>timestamptz</ul>< /ul>
  » pc_unit,string,false,none,列の単位を返します。
  » pc_col_type,string,false,none,内部テーブルの主キーの一部として列を返すか、否か。 'k'はキー列を表し、'm'はメンバー/ノーマル列を表します。
  » pc_graphable,boolean,false,none,列のデータをチャートにグラフ化できるかどうかを決定します。
  » pc_calc_pit,boolean,false,none,サーバーがこの列のメトリックデータのポイントインタイムを計算するかどうかを決定します。
  » pc_pit_default,boolean,false,none,メトリックデータをデフォルトでポイントインタイムで保存するかどうかを決定します。詳細については、ドキュメントの'Custom Probes'セクションを参照してください。
  alternate_code,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,なし

.. _列挙値-10:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  collection_method,w
  collection_method,b
  collection_method,s
  platform,unix
  platform,windows
  pc_data_type,bigint
  pc_data_type,char
  pc_data_type,decimal
  pc_data_type,double precision
  pc_data_type,integer
  pc_data_type,numeric
  pc_data_type,real
  pc_data_type,text
  pc_data_type,text\[]
  pc_data_type,timestamp
  pc_data_type,timestamptz
  pc_col_type,m
  pc_col_type,k

CustomProbePutData
------------------

.. code:: json

   {
     "interval_min": 0,
     "interval_sec": 0,
     "lifetime": 0,
     "enabled": true,
     "probe_code": "string",
     "probe_columns": {
       "changed": [
         {
           "pc_id": 0,
           "pc_unit": "string",
           "pc_graphable": true
         }
       ]
     },
     "alternate_code": {
       "changed": [
         {
           "server_version_id": 0,
           "server_probe_code": "string",
           "extension_version": 0
         }
       ],
       "deleted": [
         {
           "server_version_id": 0
         }
       ],
       "added": [
         {
           "server_version_id": 0,
           "server_probe_code": "string",
           "extension_version": 0
         }
       ]
     }
   }

.. _プロパティ-32:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  interval_min,integer,false,none,プローブが統計を収集する頻度を分単位で定義します。指定できる値は0〜2880です。
  interval_sec,integer,false,none,プローブが統計を収集する頻度を秒単位で定義します。指定できる値は0〜59です。
  lifetime,integer,false,none,履歴データの保持期間を日単位で定義します。有効な範囲は1〜365です。  'discard_history'がtrueに設定されている場合、この値は効果がありません。
  enabled,boolean,false,none,プローブがデフォルトで有効になっているかどうかを決定します。
  probe_code,string,false,none,コードの定義ごとに統計を収集するための<b> SQL/Batchスクリプト/シェルスクリプト/WMIスクリプト</b>。
  probe_columns,object,false,none,なし
  » changed,\ :ref:`[ProbeColumn <#tocs_probecolumn>` ],false,none,変更されたプローブカラムのリスト
  alternate_code,object,false,none,なし
  » changed,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,一部のサーバーバージョンの変更された代替プローブコードのリスト
  » deleted,\ :ref:`[DeletedAlternateServerProbeCode <#tocs_deletedalternateserverprobecode>` ],false,none,一部のサーバーバージョンの削除された代替プローブコードのリスト
  » added,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,一部のサーバーバージョンで追加された代替プローブコードのリスト

プローブ
--------

.. code:: json

   {
     "probe_id": 0,
     "probe_name": "string",
     "default_interval_min": 0,
     "interval_min": 0,
     "default_interval_sec": 0,
     "interval_sec": 0,
     "default_interval": 0,
     "interval": 0,
     "default_lifetime": 0,
     "lifetime": 0,
     "default_enabled": true,
     "enabled": true,
     "target_type_id_returned": 0
   }

.. _プロパティ-33:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  probe_id,integer,false,none,プローブの一意のID
  probe_name,string,false,none,プローブの名前
  default_interval_min,integer,false,none,プローブが統計を収集するデフォルトの間隔を分単位で定義します。指定できる値は0〜2880です。
  interval_min,integer,false,none,プローブが統計を収集する頻度を分単位で定義します。指定できる値は0〜2880です。
  default_interval_sec,integer,false,none,プローブが統計を収集するデフォルトの間隔を秒単位で定義します。指定できる値は0〜59です。
  interval_sec,integer,false,none,プローブが統計を収集する頻度を秒単位で定義します。指定できる値は0〜59です。
  default_interval,integer,false,none,プローブが統計を収集するデフォルトの間隔を秒単位で定義します。
  interval,integer,false,none,プローブが統計を収集する頻度を秒単位で定義します。10以上である必要があります
  default_lifetime,integer,false,none,デフォルトの履歴データの保持期間を日単位で定義します。
  lifetime,integer,false,none,履歴データの保持期間を日単位で定義します。有効な範囲は1〜365です。 'discard_history'がtrueに設定されている場合、この値は効果がありません。
  default_enabled,boolean,false,none,デフォルトのプローブ有効/無効値を定義します。
  enabled,boolean,false,none,プローブがデフォルトで有効/無効かどうかを指定します。
  target_type_id_returned,integer,false,none,戻りターゲットタイプの値を定義します。 <ul><li>target_type <b>100</b>のプローブは、エージェントの統計を収集します。</li><li>target_type <b>200</b>のプローブは、収集を担当します。 </li><li>target_type <b>300</b>のプローブは、データベースの統計を収集します。</li><li>target_type <b>400<のプローブ/b>は、スキーマの統計を収集します。</li><li>target_type <b>500</b>のプローブは、テーブルの統計を収集します。</li><li>次のプローブtarget_type <b>600</b>は、インデックスの統計を収集します。</li><li>target_type <b>700</b>のプローブは、シーケンスの統計を収集します。</li> <li>target_type <b>800</b>のプローブは、ファンクションの統計を収集します。</li><li>target_type <b>900</b>のプローブは、ファンクションの統計を収集します。 view.</li></ul>

ProbeConfigData
---------------

.. code:: json

   {
     "interval_min": 0,
     "interval_sec": 0,
     "lifetime": 0,
     "enabled": true
   }

.. _プロパティ-34:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  interval_min,integer,false,none,プローブの実行頻度分単位。許可される間隔値分単位は0〜2880です。注合計間隔は10秒より大きい必要があります。つまり、 10 >= interval_min \* 60 + interval_sec >= 172800
  interval_sec,integer,false,none,プローブの実行頻度秒単位。許可される間隔値秒単位は0〜59です。注合計間隔は10秒より大きい必要があります。つまり、 10 >= interval_min \* 60 + interval_sec >= 172800
  lifetime,integer,false,none,プローブ履歴データの保持期間日単位。つまり、 1 <= ライフタイム <= 365
  enabled,boolean,false,none,指定されたオブジェクトでプローブが有効になっているかどうかを判断します。

CopyAgentData
-------------

.. code:: json

   {
     "type": "string",
     "agent_id": 0
   }

.. _プロパティ-35:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「agent」である必要があります
  agent_id,integer,false,none,なし

CopyServerData
--------------

.. code:: json

   {
     "type": "string",
     "server_id": 0
   }

.. _プロパティ-36:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「server」である必要があります
  server_id,integer,false,none,なし

CopyDatabaseData
----------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string"
   }

.. _プロパティ-37:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「database」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし

CopySchemaData
--------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string"
   }

.. _プロパティ-38:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「スキーマ」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし

CopyAlertAgentData
------------------

.. code:: json

   {
     "type": "string",
     "agent_id": 0,
     "existing_alert_options": "I"
   }

.. _プロパティ-39:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「agent」である必要があります
  agent_id,integer,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-11:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertServerData
-------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "existing_alert_options": "I"
   }

.. _プロパティ-40:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「server」である必要があります
  server_id,integer,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-12:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertDatabaseData
---------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-41:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「database」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-13:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertSchemaData
-------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-42:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「スキーマ」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-14:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertTableData
------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string",
     "table_name": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-43:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「table」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし
  table_name,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-15:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertIndexData
------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string",
     "index_name": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-44:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,"値は""index""である必要があります"
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし
  index_name,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-16:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertFunctionData
---------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string",
     "function_name": "string",
     "function_arguments": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-45:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,値は「ファンクション」である必要があります
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし
  function_name,string,false,none,なし
  function_arguments,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-17:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

CopyAlertSequenceData
---------------------

.. code:: json

   {
     "type": "string",
     "server_id": 0,
     "database_name": "string",
     "schema_name": "string",
     "sequence_name": "string",
     "existing_alert_options": "I"
   }

.. _プロパティ-46:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  type,string,false,none,"値は""sequence""である必要があります"
  server_id,integer,false,none,なし
  database_name,string,false,none,なし
  schema_name,string,false,none,なし
  sequence_name,string,false,none,なし
  existing_alert_options,string,false,none,コピーする重複したアラートを無視/置換するか、既存のすべてのアラートをターゲットから削除するかどうかを決定します。サポートされている有効な値は次のとおりです。I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts

.. _列挙値-18:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  existing_alert_options,I
  existing_alert_options,R
  existing_alert_options,D

エージェント
------------

.. code:: json

   {
     "id": 0,
     "name": "string",
     "version": "string",
     "active": true,
     "heartbeat_tolerance": 0,
     "alert_blackout": true,
     "owner": "string",
     "team": "string",
     "gid": 0,
     "tags": [
       "string"
     ],
     "ignore_mnt_points": [
       "string"
     ]
   }

エージェント情報、バージョン、機能、およびエージェントがインストールされているホストに関する詳細を含むオブジェクトのリストを返します。

**例** \\

.. code:: json

   [{
     / *Agent information* /
     "id": 1,
     "gid": 0,
     "name": "Postgres Enterprise Manager Host"
     "version": "9.3.0",
     "active": True,
     "heartbeat_tolerance": 15,
     "alert_blackout": False,
     "owner": "postgres",
     "team": None,

     / *Deatils about the Host, on which it is installed* /
     "operating_sys": "Ubuntu 12.04.5 LTS",
     "host_name": "edb-ubuntu",
     "boot_time": "2016-09-19 12:28:27+05:30",
      "domain_name": "(none)",
      "window_domain": None,

     / *Agent capabilities* /
     "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, 
   os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart",

     / *Monitored servers* /
     "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12"
   }]

ア

.. _プロパティ-47:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  id,integer,false,none,pemエージェントのID
  name,string,false,none,エージェントの説明名前。
  version,string,false,none,pem-agentのバージョン
  active,boolean,false,none,エージェントがアクティブかどうかを判断します。アクティブエージェントは、ホストおよび監視対象サーバーの統計を収集します。
  heartbeat_tolerance,integer,false,none,エージェントのハートビート許容秒単位。ハートビートがどれだけ遅れた場合、逃したと見なされるかを指定します。
  alert_blackout,boolean,false,none,エージェントのアラートをブラックアウトするかどうかを判断します。
  owner,string,false,none,エージェントをインストールしたユーザーのユーザー名。このユーザーを所有者と呼びます。
  team,string,false,none,このエージェントを表示できるロール/ユーザーの名前。 null/空の値は、すべてのユーザーがこのエージェントを表示できることを示します。
  gid,integer,false,none,グループのID
  tags,[string],false,none,エージェントに関連付けられたタグのリスト
  ignore_mnt_points,[string],false,none,ディスク使用量の計算でマウントポイントを無視するために使用されます

.. _エージェント-1:

エージェント
------------

.. code:: json

   [
     {
       "id": 0,
       "name": "string",
       "version": "string",
       "active": true,
       "heartbeat_tolerance": 0,
       "alert_blackout": true,
       "owner": "string",
       "team": "string",
       "gid": 0,
       "tags": [
         "string"
       ],
       "ignore_mnt_points": [
         "string"
       ]
     }
   ]

エージェント情報、バージョン、機能、およびエージェントがインストールされているホストに関する詳細を含むオブジェクトのリストを返します。

**例** \\

.. code:: json

   [{
     / *Agent information* /
     "id": 1,
     "gid": 0,
     "name": "Postgres Enterprise Manager Host"
     "version": "9.3.0",
     "active": True,
     "heartbeat_tolerance": 15,
     "alert_blackout": False,
     "owner": "postgres",
     "team": None,

     / *Deatils about the Host, on which it is installed* /
     "operating_sys": "Ubuntu 12.04.5 LTS",
     "host_name": "edb-ubuntu",
     "boot_time": "2016-09-19 12:28:27+05:30",
      "domain_name": "(none)",
      "window_domain": None,

     / *Agent capabilities* /
     "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, 
   os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart",

     / *Monitored servers* /
     "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12"
   }]

ア

.. _プロパティ-48:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  id,integer,true,none,pemエージェントのID
  name,string,true,none,エージェントの説明名前。
  version,string,true,none,pem-agentのバージョン
  active,boolean,true,none,エージェントがアクティブかどうかを判断します。アクティブエージェントは、ホストおよび監視対象サーバーの統計を収集します。
  heartbeat_tolerance,integer,true,none,エージェントのハートビート許容秒単位。ハートビートがどれだけ遅れた場合、逃したと見なされるかを指定します。
  alert_blackout,boolean,true,none,エージェントのアラートをブラックアウトするかどうかを判断します。
  owner,string,true,none,エージェントをインストールしたユーザーのユーザー名。このユーザーを所有者と呼びます。
  team,string,true,none,このエージェントを表示できるロール/ユーザーの名前。 null/空の値は、すべてのユーザーがこのエージェントを表示できることを示します。
  gid,integer,false,none,グループのID
  tags,[string],false,none,エージェントに関連付けられたタグのリスト
  ignore_mnt_points,[string],false,none,ディスク使用量の計算でマウントポイントを無視するために使用されます

サーバー
--------

.. code:: json

   {
     "id": 0,
     "name": "string",
     "host": "string",
     "port": 0,
     "db": "string",
     "serviceid": "string",
     "connection_params": [
       {
         "name": "string",
         "keyword": "string",
         "value": null
       }
     ],
     "active": true,
     "alert_blackout": true,
     "owner": 0,
     "team": "string",
     "server_owner": "string",
     "is_remote_monitoring": true,
     "tags": [
       "string"
     ],
     "replication_solution": "none",
     "efm_cluster_name": "string",
     "efm_service_name": "string",
     "efm_installation_path": "string",
     "patroni_cluster_name": "string",
     "patroni_installation_path": "string",
     "patroni_config_path": "string",
     "comment": "string",
     "username": "string",
     "gid": 0,
     "server_group_name": "string",
     "db_res": "string",
     "role": "string",
     "is_edb": true,
     "agent_id": 0,
     "asb_host": "string",
     "asb_port": 0,
     "asb_username": "string",
     "asb_database": "string",
     "asb_sslmode": "prefer",
     "agent_allowtakeover": false,
     "agent_capability_list": [
       "string"
     ],
     "agent_description": "string",
     "sslcompression": false,
     "use_ssh_tunnel": false,
     "tunnel_host": "string",
     "tunnel_port": 22,
     "tunnel_username": "string",
     "tunnel_authentication": false,
     "tunnel_identity_file": "string",
     "post_connection_sql": "string"
   }

.. _プロパティ-49:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  id,integer,false,none,サーバーID.注 このプロパティは、POST要求には適用されません。
  name,string,false,none,サーバー名
  host,string,false,none,サーバーホスト
  port,integer,false,none,サーバーポート
  db,string,false,none,メンテナンスデータベース
  serviceid,string,false,none,サーバーサービスID
  connection_params,[object],false,none,サーバーの接続パラメーターのリスト。
  » name,string,false,none,パラメーター名
  » keyword,string,false,none,パラメーターキーワード
  » value,any,false,none,パラメーター値
  active,boolean,false,none,サーバーがアクティブかどうかを判断します。
  alert_blackout,boolean,false,none,サーバー上のアラートがブラックアウトされているかどうかを判断します。
  owner,integer,false,none,サーバーをPEMに登録した所有者のID。
  team,string,false,none,サーバー情報を表示できるロール/ユーザー名を定義します。
  server_owner,string,false,none,PEMデータベースサーバーにサーバーを登録したユーザーの名前。
  is_remote_monitoring,boolean,false,none,このサーバーがリモートで監視されているかどうかを判断します。つまり、監視pemエージェントが監視対象サーバーと同じホストにありません。
  tags,[string],false,none,サーバーに関連付けられたタグのリスト。
  replication_solution,string,false,none,サーバーが使用するレプリケーションソリューション
  efm_cluster_name,string,false,none,EFMのクラスター名
  efm_service_name,string,false,none,EFMのサービス名
  efm_installation_path,string,false,none,EFMのインストールパス
  patroni_cluster_name,string,false,none,Patroniのクラスター名
  patroni_installation_path,string,false,none,Patroniのインストールパス
  patroni_config_path,string,false,none,Patroniの構成パス
  comment,string,false,none,サーバーの説明
  username,string,false,none,データベースサーバーに接続するためのユーザー名
  gid,integer,false,none,サーバーグループのID
  server_group_name,string,false,none,サーバーグループの名前
  db_res,string,false,none,データベース制限SQL句
  role,string,false,none,接続が使用するロール
  is_edb,boolean,false,none,サーバーはEDB Advanced Serverですか？
  agent_id,integer,false,none,サーバーにバインドされたエージェントID
  asb_host,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースホスト
  asb_port,integer,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースポート
  asb_username,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースのユーザー名
  asb_database,string,false,none,エージェントが接続するPEMデータベース
  asb_sslmode,string,false,none,PEMデータベース SSLモード
  agent_allowtakeover,boolean,false,none,サーバーを別のエージェントに引き継ぎできるかどうかを指定します。
  agent_capability_list,[string],false,none,エージェント機能の配列
  agent_description,string,false,none,エージェントの説明
  sslcompression,boolean,false,none,SSL経由で送信されるデータを圧縮するかどうかを決定します。
  use_ssh_tunnel,boolean,false,none,sshトンネルを使用するかどうかを決定します。
  tunnel_host,string,false,none,トンネルホスト名
  tunnel_port,integer,false,none,トンネルポート番号
  tunnel_username,string,false,none,トンネルのユーザー名
  tunnel_authentication,boolean,false,none,トンネル認証を使用するかどうかを決定します。
  tunnel_identity_file,string,false,none,認証に使用されるトンネルIDファイル。
  post_connection_sql,string,false,none,接続の確立後に実行されるSQL 。

.. _列挙値-19:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  replication_solution,none
  replication_solution,efm
  replication_solution,patroni
  asb_sslmode,prefer
  asb_sslmode,allow
  asb_sslmode,disable
  asb_sslmode,require
  asb_sslmode,verify-ca
  asb_sslmode,verify-full

ServerGroupBody
---------------

.. code:: json

   {
     "name": "string"
   }

.. _プロパティ-50:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,サーバーグループ名

ServerGroupBodyGet
------------------

.. code:: json

   {
     "id": 0,
     "name": "string",
     "hidden": true,
     "parent_id": 0
   }

.. _プロパティ-51:

プロパティ
^^^^^^^^^^

.. 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,サーバーグループ名
  hidden,boolean,false,none,Serverグループを非表示にするかどうかを判断します
  parent_id,integer,false,none,親サーバーグループID。注 クラスタータイプのノードは親IDを持ち、それ以外の場合はnullになります。

ServerBody
----------

.. code:: json

   {
     "name": "string",
     "host": "string",
     "port": 0,
     "db": "string",
     "serviceid": "string",
     "connection_params": [
       {
         "name": "sslmode",
         "keyword": "sslmode",
         "value": "prefer"
       },
       {
         "name": "connect_timeout",
         "keyword": "connect_timeout",
         "value": 10
       }
     ],
     "alert_blackout": true,
     "team": "string",
     "is_remote_monitoring": true,
     "tags": [
       {
         "text": "tag1",
         "color": "#8789AC"
       },
       {
         "text": "tag2",
         "color": "#0C767A"
       }
     ],
     "replication_solution": "none",
     "efm_cluster_name": "string",
     "efm_service_name": "string",
     "efm_installation_path": "string",
     "patroni_cluster_name": "string",
     "patroni_installation_path": "string",
     "patroni_config_path": "string",
     "comment": "string",
     "username": "string",
     "gid": 0,
     "hostaddr": "string",
     "db_res": "string",
     "role": "string",
     "agent_id": 0,
     "asb_host": "string",
     "asb_port": 0,
     "asb_username": "string",
     "asb_database": "string",
     "asb_sslmode": "prefer",
     "asb_password": "string",
     "agent_allowtakeover": false,
     "fgcolor": "#000000",
     "bgcolor": "#FFFFFF",
     "sslcompression": false,
     "use_ssh_tunnel": false,
     "tunnel_host": "string",
     "tunnel_port": 22,
     "tunnel_username": "string",
     "tunnel_password": "string",
     "tunnel_authentication": false,
     "tunnel_identity_file": "string",
     "post_connection_sql": "string"
   }

.. _プロパティ-52:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,サーバー名
  host,string,false,none,サーバーホスト名またはアドレス
  port,integer,false,none,サーバーポート
  db,string,false,none,メンテナンスデータベース
  serviceid,string,false,none,サーバーサービスID
  connection_params,[object],false,none,サーバーの接続パラメーターのリスト。
  » name,string,false,none,パラメーター名
  » keyword,string,false,none,パラメーターキーワード
  » value,any,false,none,パラメーター値
  alert_blackout,boolean,false,none,サーバー上のアラートがブラックアウトされているかどうかを判断します。
  team,string,false,none,サーバー情報を表示できるロール/ユーザー名を定義します。
  is_remote_monitoring,boolean,false,none,このサーバーがリモートで監視されているかどうかを判断します。つまり、監視pemエージェントが監視対象サーバーと同じホストにありません。
  tags,[object],false,none,サーバーに関連付けられたタグのリスト。
  » text,string,false,none,タグの名前。
  » color,string,false,none,タグに関連付けられた色。
  replication_solution,string,false,none,サーバーが使用するレプリケーションソリューション
  efm_cluster_name,string,false,none,EFMのクラスター名
  efm_service_name,string,false,none,EFMのサービス名
  efm_installation_path,string,false,none,EFMのインストールパス
  patroni_cluster_name,string,false,none,Patroniのクラスター名
  patroni_installation_path,string,false,none,Patroniのインストールパス
  patroni_config_path,string,false,none,Patroniの構成パス
  comment,string,false,none,サーバーの説明
  username,string,false,none,データベースサーバーに接続するためのユーザー名
  gid,integer,false,none,サーバーグループのID
  hostaddr,string,false,none,サーバーホストアドレス
  db_res,string,false,none,データベース制限SQL句
  role,string,false,none,接続が使用するロール
  agent_id,integer,false,none,サーバーにバインドされたエージェントID
  asb_host,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースホスト
  asb_port,integer,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースポート
  asb_username,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースのユーザー名
  asb_database,string,false,none,エージェントが接続するPEMデータベース
  asb_sslmode,string,false,none,PEMデータベース SSLモード
  asb_password,string,false,none,空の文字列
  agent_allowtakeover,boolean,false,none,サーバーを別のエージェントに引き継ぎできるかどうかを指定します。
  fgcolor,string,false,none,ブラウザツリー内のサーバーノードの前景色。デフォルトは黒#000000
  bgcolor,string,false,none,ブラウザツリーのサーバーノードの背景色。デフォルトは白#FFFFFF
  sslcompression,boolean,false,none,SSL経由で送信されるデータを圧縮するかどうかを決定します。
  use_ssh_tunnel,boolean,false,none,sshトンネルを使用するかどうかを決定します。
  tunnel_host,string,false,none,トンネルホスト名
  tunnel_port,integer,false,none,トンネルポート番号
  tunnel_username,string,false,none,トンネルのユーザー名
  tunnel_password,string,false,none,トンネルパスワード
  tunnel_authentication,boolean,false,none,トンネル認証を使用するかどうかを決定します。
  tunnel_identity_file,string,false,none,認証に使用されるトンネルIDファイル。
  post_connection_sql,string,false,none,接続の確立後に実行されるSQL 。

.. _列挙値-20:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  replication_solution,none
  replication_solution,efm
  replication_solution,patroni
  asb_sslmode,prefer
  asb_sslmode,allow
  asb_sslmode,disable
  asb_sslmode,require
  asb_sslmode,verify-ca
  asb_sslmode,verify-full

ServerBodyUpdate
----------------

.. code:: json

   {
     "name": "string",
     "host": "string",
     "port": 0,
     "db": "string",
     "serviceid": "string",
     "connection_params": {
       "added": [
         {
           "keyword": "hostaddr",
           "name": "hostaddr",
           "value": "qwde"
         }
       ],
       "changed": [
         {
           "keyword": "connect_timeout",
           "name": "connect_timeout",
           "value": "20"
         }
       ],
       "deleted": [
         {
           "keyword": "sslmode",
           "name": "sslmode",
           "value": "prefer"
         }
       ]
     },
     "alert_blackout": true,
     "team": "string",
     "is_remote_monitoring": true,
     "tags": {
       "added": [
         {
           "color": "#0C767A",
           "text": "tag4"
         }
       ],
       "deleted": [
         {
           "text": "tag1",
           "color": "#8789AC",
           "old_text": "tag2"
         }
       ],
       "changed": [
         {
           "old_text": "tag",
           "text": "tag3"
         }
       ]
     },
     "replication_solution": "none",
     "efm_cluster_name": "string",
     "efm_service_name": "string",
     "efm_installation_path": "string",
     "patroni_cluster_name": "string",
     "patroni_installation_path": "string",
     "patroni_config_path": "string",
     "comment": "string",
     "username": "string",
     "gid": 0,
     "hostaddr": "string",
     "db_res": "string",
     "role": "string",
     "agent_id": 0,
     "asb_host": "string",
     "asb_port": 0,
     "asb_username": "string",
     "asb_database": "string",
     "asb_sslmode": "prefer",
     "asb_password": "string",
     "agent_allowtakeover": false,
     "fgcolor": "#000000",
     "bgcolor": "#FFFFFF",
     "sslcompression": false,
     "use_ssh_tunnel": false,
     "tunnel_host": "string",
     "tunnel_port": 22,
     "tunnel_username": "string",
     "tunnel_password": "string",
     "tunnel_authentication": false,
     "tunnel_identity_file": "string",
     "post_connection_sql": "string"
   }

.. _プロパティ-53:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,サーバー名
  host,string,false,none,サーバーホスト名またはアドレス
  port,integer,false,none,サーバーポート
  db,string,false,none,メンテナンスデータベース
  serviceid,string,false,none,サーバーサービスID
  connection_params,[object],false,none,サーバーの接続パラメーターのリスト。
  » name,string,false,none,パラメーター名
  » keyword,string,false,none,パラメーターキーワード
  » value,any,false,none,パラメーター値
  alert_blackout,boolean,false,none,サーバー上のアラートがブラックアウトされているかどうかを判断します。
  team,string,false,none,サーバー情報を表示できるロール/ユーザー名を定義します。
  is_remote_monitoring,boolean,false,none,このサーバーがリモートで監視されているかどうかを判断します。つまり、監視pemエージェントが監視対象サーバーと同じホストにありません。
  tags,[object],false,none,サーバーに関連付けられたタグのリスト。
  » text,string,true,none,タグの名前。
  » color,string,true,none,タグに関連付けられた色。
  » old_text,string¦null,false,none,タグの以前の名前変更の追跡に使用されます。
  replication_solution,string,false,none,サーバーが使用するレプリケーションソリューション
  efm_cluster_name,string,false,none,EFMのクラスター名
  efm_service_name,string,false,none,EFMのサービス名
  efm_installation_path,string,false,none,EFMのインストールパス
  patroni_cluster_name,string,false,none,Patroniのクラスター名
  patroni_installation_path,string,false,none,Patroniのインストールパス
  patroni_config_path,string,false,none,Patroniの構成パス
  comment,string,false,none,サーバーの説明
  username,string,false,none,データベースサーバーに接続するためのユーザー名
  gid,integer,false,none,サーバーグループのID
  hostaddr,string,false,none,サーバーホストアドレス
  db_res,string,false,none,データベース制限SQL句
  role,string,false,none,接続が使用するロール
  agent_id,integer,false,none,サーバーにバインドされたエージェントID
  asb_host,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースホスト
  asb_port,integer,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースポート
  asb_username,string,false,none,PEM接続の作成中にエージェントが使用するPEMデータベースのユーザー名
  asb_database,string,false,none,エージェントが接続するPEMデータベース
  asb_sslmode,string,false,none,PEMデータベース SSLモード
  asb_password,string,false,none,空の文字列
  agent_allowtakeover,boolean,false,none,サーバーを別のエージェントに引き継ぎできるかどうかを指定します。
  fgcolor,string,false,none,ブラウザツリー内のサーバーノードの前景色。デフォルトは黒#000000
  bgcolor,string,false,none,ブラウザツリーのサーバーノードの背景色。デフォルトは白#FFFFFF
  sslcompression,boolean,false,none,SSL経由で送信されるデータを圧縮するかどうかを決定します。
  use_ssh_tunnel,boolean,false,none,sshトンネルを使用するかどうかを決定します。
  tunnel_host,string,false,none,トンネルホスト名
  tunnel_port,integer,false,none,トンネルポート番号
  tunnel_username,string,false,none,トンネルのユーザー名
  tunnel_password,string,false,none,トンネルパスワード
  tunnel_authentication,boolean,false,none,トンネル認証を使用するかどうかを決定します。
  tunnel_identity_file,string,false,none,認証に使用されるトンネルIDファイル。
  post_connection_sql,string,false,none,接続の確立後に実行されるSQL 。

.. _列挙値-21:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  replication_solution,none
  replication_solution,efm
  replication_solution,patroni
  asb_sslmode,prefer
  asb_sslmode,allow
  asb_sslmode,disable
  asb_sslmode,require
  asb_sslmode,verify-ca
  asb_sslmode,verify-full

AgentBody
---------

.. code:: json

   {
     "name": "string",
     "heartbeat_tolerance": 0,
     "alert_blackout": true,
     "team": "string",
     "gid": 0,
     "tags": {
       "added": [
         {
           "color": "#0C767A",
           "text": "tag4"
         }
       ],
       "deleted": [
         {
           "text": "tag1",
           "color": "#8789AC",
           "old_text": "tag2"
         }
       ],
       "changed": [
         {
           "old_text": "tag",
           "text": "tag3"
         }
       ]
     },
     "ignore_mnt_points": [
       "string"
     ]
   }

エージェント情報、バージョン、機能、およびエージェントがインストールされているホストに関する詳細を含むオブジェクトのリストを返します。

**例** \\

.. code:: json

   [{
     / *Agent information* /
     "id": 1,
     "gid": 0,
     "name": "Postgres Enterprise Manager Host"
     "version": "9.3.0",
     "active": True,
     "heartbeat_tolerance": 15,
     "alert_blackout": False,
     "owner": "postgres",
     "team": None,

     / *Deatils about the Host, on which it is installed* /
     "operating_sys": "Ubuntu 12.04.5 LTS",
     "host_name": "edb-ubuntu",
     "boot_time": "2016-09-19 12:28:27+05:30",
      "domain_name": "(none)",
      "window_domain": None,

     / *Agent capabilities* /
     "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, 
   os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart",

     / *Monitored servers* /
     "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12"
   }]

ア

.. _プロパティ-54:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,エージェントの説明名前。
  heartbeat_tolerance,integer,false,none,エージェントのハートビート許容秒単位。ハートビートがどれだけ遅れた場合、逃したと見なされるかを指定します。
  alert_blackout,boolean,false,none,エージェントのアラートをブラックアウトするかどうかを判断します。
  team,string,false,none,このエージェントを表示できるロール/ユーザーの名前。 null/空の値は、すべてのユーザーがこのエージェントを表示できることを示します。
  gid,integer,false,none,グループのID
  tags,[object],false,none,エージェントに関連付けられたタグのリスト。
  » text,string,true,none,タグの名前。
  » color,string,true,none,タグに関連付けられた色。
  » old_text,string¦null,false,none,タグの以前の名前変更の追跡に使用されます。
  ignore_mnt_points,[string],false,none,ディスク使用量の計算でマウントポイントを無視するために使用されます

AgentJobBodyGet
---------------

.. code:: json

   {
     "jobname": "string",
     "jobenabled": true,
     "jobdesc": "string"
   }

.. _プロパティ-55:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  jobname,string,false,none,ジョブの名前。
  jobenabled,boolean,false,none,ジョブが有効か無効かを判断します。
  jobdesc,string,false,none,ジョブの説明。

AgentJobBody
------------

.. code:: json

   {
     "jobid": 0,
     "jobname": "string",
     "jobenabled": true,
     "jobdesc": "string",
     "jobcreated": "2019-08-24T14:15:22Z",
     "jobchanged": "2019-08-24T14:15:22Z",
     "jlgstatus": "string",
     "jobnextrun": "2019-08-24T14:15:22Z",
     "joblastrun": "2019-08-24T14:15:22Z",
     "is_alert_job": true,
     "notify": "string",
     "email_group_id": "string",
     "jsteps": [],
     "jschedules": [
       {
         "jscid": 0,
         "jscjobid": 0,
         "jscname": "string",
         "jscdesc": "string",
         "jscenabled": true,
         "jscstart": "2019-08-24T14:15:22Z",
         "jscend": "2019-08-24T14:15:22Z",
         "jscweekdays": [
           true
         ],
         "jscmonthdays": [
           true
         ],
         "jscmonths": [
           true
         ],
         "jschours": [
           true
         ],
         "jscminutes": [
           true
         ],
         "jscexceptions": [
           null
         ],
         "jsctimezone": "string"
       }
     ]
   }

.. _プロパティ-56:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  jobid,integer,false,none,ジョブのID。
  jobname,string,false,none,ジョブの名前。
  jobenabled,boolean,false,none,ジョブが有効か無効かを判断します。
  jobdesc,string,false,none,ジョブの説明。
  jobcreated,string(date-time),false,none,ジョブが作成されたときのタイムスタンプ。
  jobchanged,string(date-time),false,none,ジョブが最後に変更されたときのタイムスタンプ。
  jlgstatus,string,false,none,最後にジョブ実行のステータス。
  jobnextrun,string(date-time)¦null,false,none,次にスケジュールされた実行のタイムスタンプ。
  joblastrun,string(date-time)¦null,false,none,最終実行のタイムスタンプ。
  is_alert_job,boolean,false,none,ジョブがアラートジョブであるかどうかを示します。
  notify,string,false,none,ジョブの通知設定。
  email_group_id,string,false,none,通知用のメールグループのID。
  jsteps,[object],false,none,ジョブのステップのリスト。
  » jstid,integer,false,none,ステップのID。
  » jstjobid,integer,false,none,ステップに関連付けられたジョブのID。
  » jstname,string,false,none,ステップの名前。
  » jstdesc,string,false,none,ステップの説明。
  » jstenabled,boolean,false,none,ステップが有効か無効かを決定します。
  » jstkind,boolean,false,none,ステップの種類を決定します。 SQLステップの場合はTrue、Batchステップの場合はFalse。
  » jstcode,string,false,none,ステップのコードまたはスクリプト。
  » server_id,integer,false,none,ステップに関連付けられたサーバーのID。
  » database_name,string,false,none,ステップに関連付けられたデータベースの名前。
  » jstonerror,string,false,none,ステップ'Fail'、'Success'、'Ignore'の実行中にエラーが発生した場合のエージェントの動作を指定します。
  jschedules,[object],false,none,ジョブのスケジュールのリスト。
  » jscid,integer¦null,false,none,スケジュールのID。
  » jscjobid,integer¦null,false,none,スケジュールに関連付けられたジョブのID。
  » jscname,string,false,none,スケジュールの名前。
  » jscdesc,string,false,none,スケジュールの説明。
  » jscenabled,boolean,false,none,スケジュールが有効か無効かを決定します。
  » jscstart,string(date-time),false,none,スケジュールの開始日時。
  » jscend,string(date-time),false,none,スケジュールの終了日時。
  » jscweekdays,[boolean],false,none,スケジュールの平日のリスト。
  » jscmonthdays,[boolean],false,none,スケジュールの月日のリスト。
  » jscmonths,[boolean],false,none,スケジュールの月のリスト。
  » jschours,[boolean],false,none,スケジュールの時間のリスト。
  » jscminutes,[boolean],false,none,スケジュールの議事録のリスト。
  » jscexceptions,[any],false,none,スケジュールの例外のリスト。
  » jsctimezone,string,false,none,スケジュールのタイムゾーン。

AgentJobBodyPut
---------------

.. code:: json

   {
     "jobname": "string",
     "jobenabled": true,
     "jobdesc": "string",
     "jsteps": {
       "added": [
         {
           "jstname": "string",
           "jstdesc": "string",
           "jstenabled": true,
           "jstkind": true,
           "jstcode": "string",
           "server_id": 0,
           "database_name": "string",
           "jstonerror": "f"
         }
       ],
       "changed": [
         {
           "jstid": 0,
           "jstname": "string",
           "jstdesc": "string",
           "jstenabled": true,
           "jstkind": true,
           "jstcode": "string",
           "server_id": 0,
           "database_name": "string",
           "jstonerror": "f",
           "jstnextrun": "string"
         }
       ]
     },
     "jschedules": {
       "added": [
         {
           "jscname": "string",
           "jscdesc": "string",
           "jscenabled": true,
           "jscstart": "2023-10-09 22:43 +05:30",
           "jscend": "2023-10-11 22:43 +05:30",
           "jscweekdays": "Monday",
           "jscmonthdays": 1,
           "jscmonths": "January",
           "jschours": 0,
           "jscminutes": 0,
           "jscexceptions": [
             {
               "jexdate": "2023-10-19",
               "jextime": "09:39:00"
             }
           ],
           "jsctimezone": "Asia/Calcutta"
         }
       ],
       "changed": [
         {
           "jscid": 0,
           "jscname": "string",
           "jscdesc": "string",
           "jscenabled": true,
           "jscstart": "2023-10-09 22:43 +05:30",
           "jscend": "2023-10-11 22:43 +05:30",
           "jscweekdays": "Monday",
           "jscmonthdays": 1,
           "jscmonths": "January",
           "jschours": 0,
           "jscminutes": 0,
           "jscexceptions": [
             {
               "jexdate": "2023-10-19",
               "jextime": "09:39:00"
             }
           ],
           "jsctimezone": "Asia/Calcutta"
         }
       ]
     },
     "notify": "DEFAULT",
     "email_group_id": "string"
   }

.. _プロパティ-57:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  jobname,string,false,none,ジョブの名前。
  jobenabled,boolean,false,none,ジョブが有効か無効かを判断します。
  jobdesc,string,false,none,ジョブの説明。
  jsteps,object,false,none,なし
  » added,[object],false,none,追加されたステップのリスト。
  »» jstname,string,false,none,ステップの名前。
  »» jstdesc,string,false,none,ステップの説明。
  »» jstenabled,boolean,false,none,ステップが有効か無効かを決定します。
  »» jstkind,boolean,false,none,ステップの種類を決定します。 SQLステップの場合はTrue、Batchステップの場合はFalse。
  »» jstcode,string,false,none,ステップのコードまたはスクリプト。
  »» server_id,integer,false,none,ステップに関連付けられたサーバーのID。
  »» database_name,string,false,none,ステップに関連付けられたデータベースの名前。
  »» jstonerror,string,false,none,ステップ'Fail'、'Success'、'Ignore'の実行中にエラーが発生した場合のエージェントの動作を指定します。
  » changed,[object],false,none,変更されたステップのリスト。
  »» jstid,integer,false,none,ステップのID。
  »» jstname,string,false,none,ステップの名前。
  »» jstdesc,string,false,none,ステップの説明。
  »» jstenabled,boolean,false,none,ステップが有効か無効かを決定します。
  »» jstkind,boolean,false,none,ステップの種類を決定します。 SQLステップの場合はTrue、Batchステップの場合はFalse。
  »» jstcode,string,false,none,ステップのコードまたはスクリプト。
  »» server_id,integer,false,none,ステップに関連付けられたサーバーのID。
  »» database_name,string,false,none,ステップに関連付けられたデータベースの名前。
  »» jstonerror,string,false,none,ステップ'Fail'、'Success'、'Ignore'の実行中にエラーが発生した場合のエージェントの動作を指定します。
  »» jstnextrun,string,false,none,なし
  jschedules,object,false,none,なし
  » added,[object],false,none,追加されたスケジュールのリスト。
  »» jscname,string,false,none,スケジュールの名前。
  »» jscdesc,string,false,none,スケジュールの説明。
  »» jscenabled,boolean,false,none,スケジュールが有効か無効かを決定します。
  »» jscstart,string,false,none,スケジュールの開始日時YYYY-MM-DD HH:mm ±HH:mm 。
  »» jscend,string,false,none,スケジュールの終了日時YYYY-MM-DD HH:mm ±HH:mm 。
  »» jscweekdays,[any],false,none,スケジュールの平日のリスト。
  »» jscmonthdays,[any],false,none,スケジュールの月の日のリスト。注ここで、 '32'は月の最終日を表します
  »» jscmonths,[any],false,none,スケジュールの月のリスト。
  »» jschours,[any],false,none,スケジュールの時間0〜23のリスト。
  »» jscminutes,[any],false,none,スケジュールの分リスト0-59。
  »» jscexceptions,[object],false,none,スケジュールの例外のリスト。
  »»» jexdate,string(date),false,none,スケジュール例外の日付。
  »»» jextime,string(time),false,none,スケジュール例外の時間。
  »» jsctimezone,string,false,none,スケジュールのタイムゾーン。
  » changed,[object],false,none,変更されたスケジュールのリスト。
  »» jscid,integer¦null,false,none,スケジュールのID。
  »» jscname,string,false,none,スケジュールの名前。
  »» jscdesc,string,false,none,スケジュールの説明。
  »» jscenabled,boolean,false,none,スケジュールが有効か無効かを決定します。
  »» jscstart,string,false,none,スケジュールの開始日時YYYY-MM-DD HH:mm ±HH:mm 。
  »» jscend,string,false,none,スケジュールの終了日時YYYY-MM-DD HH:mm ±HH:mm 。
  »» jscweekdays,[any],false,none,スケジュールの平日のリスト。
  »» jscmonthdays,[any],false,none,スケジュールの月の日のリスト。注ここで、 '32'は月の最終日を表します
  »» jscmonths,[any],false,none,スケジュールの月のリスト。
  »» jschours,[any],false,none,スケジュールの時間0〜23のリスト。
  »» jscminutes,[any],false,none,スケジュールの分リスト0-59。
  »» jscexceptions,[object],false,none,スケジュールの例外のリスト。
  »»» jexdate,string(date),false,none,スケジュール例外の日付。
  »»» jextime,string(time),false,none,スケジュール例外の時間。
  »» jsctimezone,string,false,none,スケジュールのタイムゾーン。
  notify,string,false,none,ジョブの通知設定。
  email_group_id,string,false,none,通知用のメールグループのID。

.. _列挙値-22:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  jstonerror,f
  jstonerror,s
  jstonerror,i
  jstonerror,f
  jstonerror,s
  jstonerror,i
  jscweekdays,Monday
  jscweekdays,Tuesday
  jscweekdays,Wednesday
  jscweekdays,Thursday
  jscweekdays,Friday
  jscweekdays,Saturday
  jscweekdays,Sunday
  jscmonthdays,1
  jscmonthdays,2
  jscmonthdays,3
  jscmonthdays,4
  jscmonthdays,5
  jscmonthdays,6
  jscmonthdays,7
  jscmonthdays,8
  jscmonthdays,9
  jscmonthdays,10
  jscmonthdays,11
  jscmonthdays,12
  jscmonthdays,13
  jscmonthdays,14
  jscmonthdays,15
  jscmonthdays,16
  jscmonthdays,17
  jscmonthdays,18
  jscmonthdays,19
  jscmonthdays,20
  jscmonthdays,21
  jscmonthdays,22
  jscmonthdays,23
  jscmonthdays,24
  jscmonthdays,25
  jscmonthdays,26
  jscmonthdays,27
  jscmonthdays,28
  jscmonthdays,29
  jscmonthdays,30
  jscmonthdays,31
  jscmonthdays,32
  jscmonths,January
  jscmonths,February
  jscmonths,March
  jscmonths,April
  jscmonths,May
  jscmonths,June
  jscmonths,July
  jscmonths,August
  jscmonths,September
  jscmonths,October
  jscmonths,November
  jscmonths,December
  jschours,0
  jschours,1
  jschours,2
  jschours,3
  jschours,4
  jschours,5
  jschours,6
  jschours,7
  jschours,8
  jschours,9
  jschours,10
  jschours,22
  jscminutes,0
  jscminutes,1
  jscminutes,2
  jscminutes,3
  jscminutes,4
  jscminutes,5
  jscminutes,6
  jscminutes,7
  jscminutes,8
  jscminutes,9
  jscminutes,10
  jscminutes,31
  jscminutes,32
  jscminutes,33
  jscminutes,34
  jscminutes,35
  jscminutes,36
  jscminutes,37
  jscminutes,38
  jscminutes,39
  jscminutes,51
  jscminutes,52
  jscminutes,53
  jscminutes,54
  jscminutes,55
  jscminutes,56
  jscminutes,57
  jscminutes,58
  jscminutes,59
  jsctimezone,Asia/Calcutta
  jsctimezone,Canada/Pacific
  jsctimezone,Asia/Tokyo
  jsctimezone,etc
  jscweekdays,Monday
  jscweekdays,Tuesday
  jscweekdays,Wednesday
  jscweekdays,Thursday
  jscweekdays,Friday
  jscweekdays,Saturday
  jscweekdays,Sunday
  jscmonthdays,1
  jscmonthdays,2
  jscmonthdays,3
  jscmonthdays,4
  jscmonthdays,5
  jscmonthdays,6
  jscmonthdays,7
  jscmonthdays,8
  jscmonthdays,9
  jscmonthdays,10
  jscmonthdays,11
  jscmonthdays,12
  jscmonthdays,13
  jscmonthdays,14
  jscmonthdays,15
  jscmonthdays,16
  jscmonthdays,17
  jscmonthdays,18
  jscmonthdays,19
  jscmonthdays,20
  jscmonthdays,21
  jscmonthdays,22
  jscmonthdays,23
  jscmonthdays,24
  jscmonthdays,25
  jscmonthdays,26
  jscmonthdays,27
  jscmonthdays,28
  jscmonthdays,29
  jscmonthdays,30
  jscmonthdays,31
  jscmonthdays,32
  jscmonths,January
  jscmonths,February
  jscmonths,March
  jscmonths,April
  jscmonths,May
  jscmonths,June
  jscmonths,July
  jscmonths,August
  jscmonths,September
  jscmonths,October
  jscmonths,November
  jscmonths,December
  jschours,0
  jschours,1
  jschours,2
  jschours,3
  jschours,4
  jschours,5
  jschours,6
  jschours,7
  jschours,8
  jschours,9
  jschours,10
  jschours,22
  jscminutes,0
  jscminutes,1
  jscminutes,2
  jscminutes,3
  jscminutes,4
  jscminutes,5
  jscminutes,6
  jscminutes,7
  jscminutes,8
  jscminutes,9
  jscminutes,10
  jscminutes,31
  jscminutes,32
  jscminutes,33
  jscminutes,34
  jscminutes,35
  jscminutes,36
  jscminutes,37
  jscminutes,38
  jscminutes,39
  jscminutes,51
  jscminutes,52
  jscminutes,53
  jscminutes,54
  jscminutes,55
  jscminutes,56
  jscminutes,57
  jscminutes,58
  jscminutes,59
  jsctimezone,Asia/Calcutta
  jsctimezone,Canada/Pacific
  jsctimezone,Asia/Tokyo
  jsctimezone,etc
  notify,DEFAULT
  notify,ON_FAILURE
  notify,ALWAYS
  notify,NEVER

AgentJobBodyPost
----------------

.. code:: json

   {
     "jobname": "string",
     "jobenabled": true,
     "jobdesc": "string",
     "jsteps": [],
     "jschedules": [
       {
         "jscname": "string",
         "jscdesc": "string",
         "jscenabled": true,
         "jscstart": "2023-10-09 22:43 +05:30",
         "jscend": "2023-10-11 22:43 +05:30",
         "jscweekdays": "Monday",
         "jscmonthdays": 1,
         "jscmonths": "January",
         "jschours": 0,
         "jscminutes": 0,
         "jscexceptions": [
           {
             "jexdate": "2023-10-19",
             "jextime": "09:39:00"
           }
         ],
         "jsctimezone": "Asia/Calcutta"
       }
     ],
     "notify": "DEFAULT",
     "email_group_id": "string"
   }

.. _プロパティ-58:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  jobname,string,false,none,ジョブの名前。
  jobenabled,boolean,false,none,ジョブが有効か無効かを判断します。
  jobdesc,string,false,none,ジョブの説明。
  jsteps,[object],false,none,ジョブのステップのリスト。
  » jstname,string,false,none,ステップの名前。
  » jstdesc,string,false,none,ステップの説明。
  » jstenabled,boolean,false,none,ステップが有効か無効かを決定します。
  » jstkind,boolean,false,none,ステップの種類を決定します。 SQLステップの場合はTrue、Batchステップの場合はFalse。
  » jstcode,string,false,none,ステップのコードまたはスクリプト。
  » server_id,integer,false,none,ステップに関連付けられたサーバーのID。
  » database_name,string,false,none,ステップに関連付けられたデータベースの名前。
  » jstonerror,string,false,none,ステップ'Fail'、'Success'、'Ignore'の実行中にエラーが発生した場合のエージェントの動作を指定します。
  jschedules,[object],false,none,ジョブのスケジュールのリスト。
  » jscname,string,false,none,スケジュールの名前。
  » jscdesc,string,false,none,スケジュールの説明。
  » jscenabled,boolean,false,none,スケジュールが有効か無効かを決定します。
  » jscstart,string,false,none,スケジュールの開始日時YYYY-MM-DD HH:mm ±HH:mm 。
  » jscend,string,false,none,スケジュールの終了日時YYYY-MM-DD HH:mm ±HH:mm 。
  » jscweekdays,[any],false,none,スケジュールの平日のリスト。
  » jscmonthdays,[any],false,none,スケジュールの月の日のリスト。注ここで、 '32'は月の最終日を表します
  » jscmonths,[any],false,none,スケジュールの月のリスト。
  » jschours,[any],false,none,スケジュールの時間0〜23のリスト。
  » jscminutes,[any],false,none,スケジュールの分リスト0-59。
  » jscexceptions,[object],false,none,スケジュールの例外のリスト。
  »» jexdate,string(date),false,none,スケジュール例外の日付。
  »» jextime,string(time),false,none,スケジュール例外の時間。
  » jsctimezone,string,false,none,スケジュールのタイムゾーン。
  notify,string,false,none,ジョブの通知設定。
  email_group_id,string,false,none,通知用のメールグループのID。

.. _列挙値-23:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  jstonerror,f
  jstonerror,s
  jstonerror,i
  jscweekdays,Monday
  jscweekdays,Tuesday
  jscweekdays,Wednesday
  jscweekdays,Thursday
  jscweekdays,Friday
  jscweekdays,Saturday
  jscweekdays,Sunday
  jscmonthdays,1
  jscmonthdays,2
  jscmonthdays,3
  jscmonthdays,4
  jscmonthdays,5
  jscmonthdays,6
  jscmonthdays,7
  jscmonthdays,8
  jscmonthdays,9
  jscmonthdays,10
  jscmonthdays,11
  jscmonthdays,12
  jscmonthdays,13
  jscmonthdays,14
  jscmonthdays,15
  jscmonthdays,16
  jscmonthdays,17
  jscmonthdays,18
  jscmonthdays,19
  jscmonthdays,20
  jscmonthdays,21
  jscmonthdays,22
  jscmonthdays,23
  jscmonthdays,24
  jscmonthdays,25
  jscmonthdays,26
  jscmonthdays,27
  jscmonthdays,28
  jscmonthdays,29
  jscmonthdays,30
  jscmonthdays,31
  jscmonthdays,32
  jscmonths,January
  jscmonths,February
  jscmonths,March
  jscmonths,April
  jscmonths,May
  jscmonths,June
  jscmonths,July
  jscmonths,August
  jscmonths,September
  jscmonths,October
  jscmonths,November
  jscmonths,December
  jschours,0
  jschours,1
  jschours,2
  jschours,3
  jschours,4
  jschours,5
  jschours,6
  jschours,7
  jschours,8
  jschours,9
  jschours,10
  jschours,22
  jscminutes,0
  jscminutes,1
  jscminutes,2
  jscminutes,3
  jscminutes,4
  jscminutes,5
  jscminutes,6
  jscminutes,7
  jscminutes,8
  jscminutes,9
  jscminutes,10
  jscminutes,31
  jscminutes,32
  jscminutes,33
  jscminutes,34
  jscminutes,35
  jscminutes,36
  jscminutes,37
  jscminutes,38
  jscminutes,39
  jscminutes,51
  jscminutes,52
  jscminutes,53
  jscminutes,54
  jscminutes,55
  jscminutes,56
  jscminutes,57
  jscminutes,58
  jscminutes,59
  jsctimezone,Asia/Calcutta
  jsctimezone,Canada/Pacific
  jsctimezone,Asia/Tokyo
  jsctimezone,etc
  notify,DEFAULT
  notify,ON_FAILURE
  notify,ALWAYS
  notify,NEVER

データベース
------------

.. code:: json

   {
     "database_name": "string",
     "connections_allowed": true,
     "system_database": true,
     "recorded_time": "2019-08-24T14:15:22Z",
     "encoding": "string",
     "server_id": 0
   }

.. _プロパティ-59:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  database_name,string,false,none,データベース名
  connections_allowed,boolean,false,none,データベースへの接続を許可するかどうかを決定します。
  system_database,boolean,false,none,データベースがシステムデータベースであるかどうかを判断します。
  recorded_time,string(date-time),false,none,データベースがPEMエージェントによって最初に検出されたときを指定します。
  encoding,string,false,none,データベースエンコーディング
  server_id,integer,false,none,データベースのサーバーID

スキーマ
--------

.. code:: json

   {
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "recorded_time": "2019-08-24T14:15:22Z"
   }

.. _プロパティ-60:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  schema_name,string,false,none,スキーマ名
  database_name,string,false,none,スキーマのデータベース名
  server_id,integer,false,none,サーバーIDスキーマ
  recorded_time,string(date-time),false,none,スキーマがPEMエージェントによって最初に検出されたときを指定します。

テーブル
--------

.. code:: json

   {
     "table_name": "string",
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "has_primary_key": true,
     "recorded_time": "string"
   }

.. _プロパティ-61:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  table_name,string,false,none,テーブル名
  schema_name,string,false,none,スキーマ名
  database_name,string,false,none,データベース名
  server_id,integer,false,none,サーバーID
  has_primary_key,boolean,false,none,テーブルに主キーがあるかどうかを判断します。
  recorded_time,string,false,none,テーブルがPEMエージェントによって最初に検出されたときを指定します。

インデックス
------------

.. code:: json

   {
     "index_name": "string",
     "ind_keys": [
       0
     ],
     "table_name": "string",
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "recorded_time": "string"
   }

.. _プロパティ-62:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  index_name,string,false,none,インデックス名
  ind_keys,[integer],false,none,テーブル内のインデックス付き列の位置
  table_name,string,false,none,テーブル名
  schema_name,string,false,none,スキーマ
  database_name,string,false,none,データベース名
  server_id,integer,false,none,サーバーID
  recorded_time,string,false,none,インデックスがPEMエージェントによって最初に検出されたときを指定します。

シークエンス
------------

.. code:: json

   {
     "sequence_name": "string",
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "recorded_time": "2019-08-24T14:15:22Z"
   }

.. _プロパティ-63:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  sequence_name,string,false,none,シークエンス名
  schema_name,string,false,none,スキーマ名
  database_name,string,false,none,データベース名
  server_id,integer,false,none,サーバーID
  recorded_time,string(date-time),false,none,シーケンスがPEMエージェントによって最初に検出されたときを指定します。

ファンクション
--------------

.. code:: json

   {
     "function_name": "string",
     "function_type": "string",
     "return_type": "string",
     "arg_types": [
       "string"
     ],
     "function_binary": "string",
     "extension_name": "string",
     "package_name": "string",
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "recorded_time": "2019-08-24T14:15:22Z"
   }

.. _プロパティ-64:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  function_name,string,false,none,ファンクション名
  function_type,string,false,none,ファンクションタイプ
  return_type,string,false,none,ファンクションの戻り値の型
  arg_types,[string],false,none,ファンクションの引数の型
  function_binary,string,false,none,なし
  extension_name,string,false,none,なし
  package_name,string,false,none,ファンクションパッケージ名
  schema_name,string,false,none,ファンクションスキーマ
  database_name,string,false,none,ファンクションデータベース名
  server_id,integer,false,none,ファンクションサーバーID
  recorded_time,string(date-time),false,none,ファンクションがPEMエージェントによって最初に検出されたときを指定します。

ビュー
------

.. code:: json

   {
     "view_name": "string",
     "view_type": "string",
     "ispopulated": true,
     "view_owner": "string",
     "definition": "string",
     "tablespace_name": "string",
     "schema_name": "string",
     "database_name": "string",
     "server_id": 0,
     "recorded_time": "string"
   }

.. _プロパティ-65:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  view_name,string,false,none,ビュー名
  view_type,string,false,none,ビュータイプ
  ispopulated,boolean,false,none,ビューが設定されているかどうかを判断します。
  view_owner,string,false,none,ビューの所有者
  definition,string,false,none,ビュー定義
  tablespace_name,string,false,none,ビューテーブルスペース
  schema_name,string,false,none,ビュースキーマ
  database_name,string,false,none,データベースを見る
  server_id,integer,false,none,ビューサーバーID
  recorded_time,string,false,none,ビューがPEMエージェントによって最初に検出されたときを指定します。

Webhook
-------

.. code:: json

   {
     "id": 0,
     "name": "string",
     "url": "string",
     "enabled": true,
     "method": "POST",
     "http_headers": [
       {
         "http_header_id": 0,
         "http_header_key": "string",
         "http_header_value": "string"
       }
     ],
     "payload_template": "{text: You have new alert from PEM, attachments: [{text: AlertID \n%AlertID% \nAlertName \n%AlertName%}]}",
     "low_alert": true,
     "med_alert": true,
     "high_alert": true,
     "cleared_alert": true,
     "payload_type": "ALERT"
   }

.. _プロパティ-66:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  id,integer,false,none,Webhook ID
  name,string,false,none,Webhook名
  url,string,false,none,Webhook URL
  enabled,boolean,false,none,Webhookが有効になっているかどうかを判断します。
  method,string,false,none,リクエストメソッド
  http_headers,\ :ref:`Query information <Webhook>` ],false,none,Webhookで使用されるHTTPヘッダーのキー/値ペアのリスト
  payload_template,string,false,none,ペイロードテンプレート。以下は、Slackのペイロードの例です。
  low_alert,boolean,false,none,低アラートを有効にするかどうかを決定します。
  med_alert,boolean,false,none,中程度のアラートを有効にするかどうかを決定します。
  high_alert,boolean,false,none,厳重なアラートを有効にするかどうかを決定します。
  cleared_alert,boolean,false,none,クリアされたアラートが有効かどうかを判断します。
  payload_type,string,false,none,ペイロードタイプ

.. _列挙値-24:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  method,POST
  method,PUT
  payload_type,ALERT
  payload_type,JOB

WebhookPostData
---------------

.. code:: json

   {
     "name": "string",
     "url": "string",
     "enabled": true,
     "method": "POST",
     "http_headers": [
       {
         "http_header_key": "string",
         "http_header_value": "string"
       }
     ],
     "payload_template": "{ Alert Name:%AlertName%,type:Webhook }",
     "low_alert": true,
     "med_alert": true,
     "high_alert": true,
     "cleared_alert": true,
     "payload_type": "ALERT"
   }

.. _プロパティ-67:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,Webhook名
  url,string,false,none,Webhook URL
  enabled,boolean,false,none,Webhookが有効になっているかどうかを判断します。
  method,string,false,none,リクエストメソッド
  http_headers,\ :ref:`Query information <Webhook>` ],false,none,Webhookで使用されるHTTPヘッダーのキー/値ペアのリスト
  payload_template,string,false,none,ペイロードテンプレート
  low_alert,boolean,false,none,低アラートを有効にするかどうかを決定します。
  med_alert,boolean,false,none,中程度のアラートを有効にするかどうかを決定します。
  high_alert,boolean,false,none,厳重なアラートを有効にするかどうかを決定します。
  cleared_alert,boolean,false,none,クリアされたアラートが有効かどうかを判断します。
  payload_type,string,false,none,ペイロードタイプ

.. _列挙値-25:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  method,POST
  method,PUT
  payload_type,ALERT
  payload_type,JOB

WebhookPutData
--------------

.. code:: json

   {
     "name": "string",
     "url": "string",
     "enabled": true,
     "method": "POST",
     "http_headers": {
       "added": [
         {
           "http_header_key": "string",
           "http_header_value": "string"
         }
       ],
       "changed": [
         {
           "http_header_id": 0,
           "http_header_key": "string",
           "http_header_value": "string"
         }
       ],
       "deleted": [
         {
           "http_header_id": 0
         }
       ],
       "payload_type": "ALERT"
     },
     "payload_template": "{text: You have new alert from PEM, attachments: [{text: AlertID \n%AlertID% \nAlertName \n%AlertName%}]}",
     "low_alert": true,
     "med_alert": true,
     "high_alert": true,
     "cleared_alert": true
   }

.. _プロパティ-68:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,Webhook名
  url,string,false,none,Webhook URL
  enabled,boolean,false,none,Webhookが有効になっているかどうかを判断します。
  method,string,false,none,リクエストメソッド
  http_headers,object,false,none,なし
  » added,\ :ref:`Query information <Webhook>` ],false,none,追加するHTTPヘッダーキー/値ペアのリスト
  » changed,\ :ref:`Query information <Webhook>` ],false,none,更新するHTTPヘッダーのキー/値ペアのリスト
  » deleted,[object],false,none,削除するHTTPヘッダーIDのリスト
  »» http_header_id,integer,false,none,HTTPヘッダーのID
  » payload_type,string,false,none,ペイロードタイプ
  payload_template,string,false,none,ペイロードテンプレート。以下は、Slackのペイロードの例です。
  low_alert,boolean,false,none,低アラートを有効にするかどうかを決定します。
  med_alert,boolean,false,none,中程度のアラートを有効にするかどうかを決定します。
  high_alert,boolean,false,none,厳重なアラートを有効にするかどうかを決定します。
  cleared_alert,boolean,false,none,クリアされたアラートが有効かどうかを判断します。

.. _列挙値-26:

列挙値
''''''

.. csv-table::
  :header: Property,Value
  :widths: 25,25
  :align: left
  :class: longtable

  method,POST
  method,PUT
  payload_type,ALERT
  payload_type,JOB

WebhookGetHTTPHeaders
---------------------

.. code:: json

   {
     "http_header_id": 0,
     "http_header_key": "string",
     "http_header_value": "string"
   }

.. _プロパティ-69:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  http_header_id,integer,false,none,HTTPヘッダーのID
  http_header_key,string,false,none,HTTPヘッダーキーの名前
  http_header_value,string,false,none,HTTPヘッダーキーの名前

WebhookHTTPヘッダー
-------------------

.. code:: json

   {
     "http_header_key": "string",
     "http_header_value": "string"
   }

.. _プロパティ-70:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  http_header_key,string,false,none,HTTPヘッダーキーの名前
  http_header_value,string,false,none,HTTPヘッダーキーの名前

メールグループ
--------------

.. code:: json

   {
     "id": 0,
     "oid": 0,
     "gid": 0,
     "name": "string",
     "to_addr": "string",
     "cc_addr": "string",
     "bcc_addr": "string",
     "from_addr": "string",
     "reply_to_addr": "string",
     "subject_prefix": "string",
     "from_time": "00:00:00",
     "to_time": "23:59:59"
   }

.. _プロパティ-71:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  id,integer,false,none,メールグループID
  oid,integer,false,none,メールグループオプションID
  gid,integer,false,none,メールグループID
  name,string,false,none,メールグループ名
  to_addr,string,false,none,メールグループオプションの受信者アドレス
  cc_addr,string,false,none,メールグループオプション CCアドレス
  bcc_addr,string,false,none,メールグループオプション BCCアドレス
  from_addr,string,false,none,メールグループオプションの送信者アドレス
  reply_to_addr,string,false,none,メールグループオプションの返信先アドレス
  subject_prefix,string,false,none,メールグループオプションの件名プレフィックス
  from_time,string,false,none,メンバーの時間から選択した時間範囲までのメールグループオプション
  to_time,string,false,none,メンバーの時間範囲を選択するメールグループオプション

EmailGroupsPostData
-------------------

.. code:: json

   {
     "name": "string",
     "options": [
       {
         "to_addr": "string",
         "cc_addr": "string",
         "bcc_addr": "string",
         "from_addr": "string",
         "reply_to_addr": "string",
         "subject_prefix": "string",
         "from_time": "00:00:00",
         "to_time": "23:59:59"
       }
     ]
   }

.. _プロパティ-72:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,メールグループ名
  options,\ :ref:`[EmailGroupOptions <#tocs_emailgroupoptions>` ],false,none,メールグループで使用されるメールグループオプションのリスト

EmailGroupsPutData
------------------

.. code:: json

   {
     "name": "string",
     "options": {
       "added": [
         {
           "to_addr": "string",
           "cc_addr": "string",
           "bcc_addr": "string",
           "from_addr": "string",
           "reply_to_addr": "string",
           "subject_prefix": "string",
           "from_time": "00:00:00",
           "to_time": "23:59:59"
         }
       ],
       "changed": [
         {
           "oid": 0,
           "to_addr": "string",
           "cc_addr": "string",
           "bcc_addr": "string",
           "from_addr": "string",
           "reply_to_addr": "string",
           "subject_prefix": "string",
           "from_time": "00:00:00",
           "to_time": "23:59:59"
         }
       ],
       "deleted": [
         {
           "oid": 0
         }
       ]
     }
   }

.. _プロパティ-73:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  name,string,false,none,メールグループ名
  options,object,false,none,なし
  » added,\ :ref:`[EmailGroupOptions <#tocs_emailgroupoptions>` ],false,none,追加するメールグループオプション
  » changed,\ :ref:`[EmailGroupOptionsChanged <#tocs_emailgroupoptionschanged>` ],false,none,更新するメールグループオプション。
  » deleted,[object],false,none,削除するHTTPヘッダーIDのリスト
  »» oid,integer,false,none,メールグループオプションID

EmailGroupOptions
-----------------

.. code:: json

   {
     "to_addr": "string",
     "cc_addr": "string",
     "bcc_addr": "string",
     "from_addr": "string",
     "reply_to_addr": "string",
     "subject_prefix": "string",
     "from_time": "00:00:00",
     "to_time": "23:59:59"
   }

.. _プロパティ-74:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  to_addr,string,false,none,メールグループオプションの受信者アドレス
  cc_addr,string,false,none,メールグループオプション CCアドレス
  bcc_addr,string,false,none,メールグループオプション BCCアドレス
  from_addr,string,false,none,メールグループオプションの送信者アドレス
  reply_to_addr,string,false,none,メールグループオプションの返信先アドレス
  subject_prefix,string,false,none,メールグループオプションの件名プレフィックス
  from_time,string,false,none,メンバーの時間から選択した時間範囲までのメールグループオプション
  to_time,string,false,none,メンバーの時間範囲を選択するメールグループオプション

EmailGroupOptionsChanged
------------------------

.. code:: json

   {
     "oid": 0,
     "to_addr": "string",
     "cc_addr": "string",
     "bcc_addr": "string",
     "from_addr": "string",
     "reply_to_addr": "string",
     "subject_prefix": "string",
     "from_time": "00:00:00",
     "to_time": "23:59:59"
   }

.. _プロパティ-75:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  oid,integer,false,none,メールグループオプションID
  to_addr,string,false,none,メールグループオプションの受信者アドレス
  cc_addr,string,false,none,メールグループオプション CCアドレス
  bcc_addr,string,false,none,メールグループオプション BCCアドレス
  from_addr,string,false,none,メールグループオプションの送信者アドレス
  reply_to_addr,string,false,none,メールグループオプションの返信先アドレス
  subject_prefix,string,false,none,メールグループオプションの件名プレフィックス
  from_time,string,false,none,メンバーの時間から選択した時間範囲までのメールグループオプション
  to_time,string,false,none,メンバーの時間範囲を選択するメールグループオプション

ExcludeDatabases
----------------

.. code:: json

   {
     "server_id": 0,
     "name": "string",
     "exclude_databases": [
       "string"
     ]
   }

.. _プロパティ-76:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  server_id,integer,false,none,サーバーID
  name,string,false,none,サーバー名
  exclude_databases,[string],false,none,データベース名を除外するコンマ区切り

ExcludeDatabasesPutData
-----------------------

.. code:: json

   {
     "exclude_databases": [
       "string"
     ]
   }

.. _プロパティ-77:

プロパティ
^^^^^^^^^^

.. csv-table::
  :header: Name,Type,Required,Restrictions,Description
  :widths: 12,8,8,8,12
  :align: left
  :class: longtable

  exclude_databases,[string],false,none,データベース名を除外するコンマ区切り