Export Custom Probes

Export Custom Probes#

post_probe_custom_export#

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/probe/custom/export/ \
  -H Content-Type: application/json \
  -H Accept: application/json \
  -H X-Auth-Token: string

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

r = requests.post(https://PEM-SERVER-IP/api/v14/probe/custom/export/, headers = headers)

print(r.json())

const inputBody = {
  "probes": [
    0
  ]
};
const headers = {
  Content-Type:application/json,
  Accept:application/json,
  X-Auth-Token:string
};

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

POST /probe/custom/export/

カスタムプローブをエクスポートします。

ボディパラメーター

{
  "probes": [
    0
  ]
}

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

body

body

CustomProbeExportData

true

なし

応答例

{
  "version": 0,
  "items": [
    {
      "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"
            }
          ]
        }
      ]
    }
  ]
}

応答#

Status

Meaning

Description

Schema

200

コマンドラインからのサーバーインストーラーの呼び出し

成功した応答

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

» version

integer

false

none

エクスポートバージョンID

» items

Query information ]

false

none

なし

»» version

integer

false

none

アラートテンプレートのエクスポートのバージョン

»» alert_templates

Query information ]

false

none

なし

»»» 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

[allOf]

false

none

なし

allOf

Name

Type

Required

Restrictions

Description

»»»» anonymous

CustomProbePostData

false

none

なし

»»»»» 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

Query information ]

false

none

なし

»»»»»» 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

拡張機能のバージョンを指定します。拡張ターゲットタイプに有効な

と

Name

Type

Required

Restrictions

Description

»»»» anonymous

object

false

none

なし

»»»»» internal_name

string

false

none

プローブがエクスポートされたシステムからのプローブの内部名

列挙値#

Property

Value

applicable_on_server

ALL

applicable_on_server

POSTGRES_SERVER

applicable_on_server

ADVANCED_SERVER

operator

>

operator

&lt;

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

注釈

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

目次