Monitored Object Status

Monitored Object Status#

get_agent_status#

コードサンプル

#  You can also use wget

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

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

r = requests.get(https://PEM-SERVER-IP/api/v14/agent/status/, headers = headers)

print(r.json())

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

fetch(https://PEM-SERVER-IP/api/v14/agent/status/,
{
  method: GET,

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

GET /agent/status/

表示されているすべてのpemエージェントのステータスを取得します。

ユーザーに表示されるpemエージェントの情報とステータスのリストを返しますトークンで表されます。

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

認証用のトークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

pemエージェントに関する情報とステータスのリストを返します。

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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

全体のディスク使用率パーセント

列挙値#

Property

Value

status

UP

status

DOWN

status

UNKNOWN

注釈

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

get_agent_status{agent_id}#

コードサンプル

#  You can also use wget

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

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

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

print(r.json())

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

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

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

GET /agent/status/{agent_id}

agent_idで識別されるpemエージェントのステータスを取得します。

パラメーター#

Name

In

Type

Required

Description

agent_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

成功した応答

エージェントステータス

400

Bad Request

エージェントが見つからないか、ユーザーに表示されない

None

レスポンススキーマ#

注釈

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

get_server_status#

コードサンプル

#  You can also use wget

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

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

r = requests.get(https://PEM-SERVER-IP/api/v14/server/status/, headers = headers)

print(r.json())

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

fetch(https://PEM-SERVER-IP/api/v14/server/status/,
{
  method: GET,

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

GET /server/status/

表示されているすべてのデータベースサーバーのステータスを取得します。

ユーザーに表示されるデータベースサーバーの情報と状態のリストを返しますトークンで表されます。

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

認証用のトークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

データベースサーバーの情報とステータスのリストを返します。

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

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

列挙値#

Property

Value

status

UP

status

DOWN

status

UNKNOWN

status

UNMANAGED

注釈

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

get_server_status{server_id}#

コードサンプル

#  You can also use wget

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

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

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

print(r.json())

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

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

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

GET /server/status/{server_id}

server_idで識別されるデータベースサーバーのステータスを取得します。

パラメーター#

Name

In

Type

Required

Description

server_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

成功した応答

ServerStatus

400

Bad Request

サーバーが見つからないか、ユーザーに表示されません

None

レスポンススキーマ#

注釈

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

目次