Object

目次

Object#

オブジェクトは、pemエージェント、監視対象サーバー、またはデータベースオブジェクトつまりデータベース、スキーマ、テーブル、インデックス、シーケンス、ファンクション、またはビューです。

get_server_group#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server_group/ \
  -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_group/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /server_group/

サーバーグループのリストを取得します。

サーバーグループのリストを返します。

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

認証用のトークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

サーバーグループのリストを返します。

ServerGroupBodyGet

注釈

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

post_server_group#

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/server_group/ \
  -H Content-Type: application/json \
  -H X-Auth-Token: string
import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

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

print(r.json())
const inputBody = {
  "name": "string"
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

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

POST /server_group/

新しいサーバーグループを追加します。

ボディパラメーター

{
  "name": "string"
}

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

body

body

ServerGroupBody

true

なし

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

get_server_group{group_id}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server_group/{group_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_group/{group_id}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server_group/{group_id},
{
  method: GET,

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

GET /server_group/{group_id}

IDでサーバーグループを取得します。

サーバーグループを返します。

パラメーター#

Name

In

Type

Required

Description

group_id

path

integer

true

なし

X-Auth-Token

header

string

true

認証用のトークン

応答例

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

応答#

注釈

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

put_server_group{group_id}#

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/server_group/{group_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string
import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/server_group/{group_id}, headers = headers)

print(r.json())
const inputBody = {
  "name": "string"
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

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

PUT /server_group/{group_id}

サーバーグループを更新します。

ボディパラメーター

{
  "name": "string"
}

パラメーター#

Name

In

Type

Required

Description

group_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

body

body

ServerGroupBody

true

正常に更新されました

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

delete_server_group{group_id}#

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/server_group/{group_id} \
  -H X-Auth-Token: string
import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/server_group/{group_id}, headers = headers)

print(r.json())
const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server_group/{group_id},
{
  method: DELETE,

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

DELETE /server_group/{group_id}

サーバーグループを削除します。

パラメーター#

Name

In

Type

Required

Description

group_id

path

integer

true

なし

X-Auth-Token

header

string

true

認証用のトークン

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

get_agent#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/agent/ \
  -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/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /agent/

pem-agent情報を取得します。

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

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

認証用のトークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

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

PEMエージェントの証明書とキーファイル

注釈

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

get_agent{agent_id}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/agent/{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/{agent_id}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /agent/{agent_id}

agent_idで識別されるエージェントの情報を取得します。

パラメーター#

Name

In

Type

Required

Description

agent_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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

put_agent{agent_id}#

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/agent/{agent_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string
import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

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

print(r.json())
const inputBody = {
  "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"
  ]
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

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

PUT /agent/{agent_id}

エージェント情報を更新します。

ボディパラメーター

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

パラメーター#

Name

In

Type

Required

Description

agent_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

body

body

AgentBody

true

なし

応答例

応答#

Status

Meaning

Description

Schema

200

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

正常に更新されました

None

レスポンススキーマ#

注釈

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

delete_agent{agent_id}#

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/agent/{agent_id} \
  -H X-Auth-Token: string
import requests
headers = {
  X-Auth-Token: string
}

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

print(r.json())
const headers = {
  X-Auth-Token:string
};

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

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

DELETE /agent/{agent_id}

PEMによるエージェントの管理を停止します。

パラメーター#

Name

In

Type

Required

Description

agent_id

path

integer

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

get_server#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/ \
  -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/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /server/

管理対象サーバーリストの取得

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

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

列挙値#

Property

Value

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

注釈

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

post_server#

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/server/ \
  -H Content-Type: application/json \
  -H X-Auth-Token: string
import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

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

print(r.json())
const inputBody = {
  "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"
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

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

POST /server/

新しい管理対象データベースサーバーを追加します。

ボディパラメーター

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

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

body

body

ServerBody

true

なし

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

get_server{server_id}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{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/{server_id}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /server/{server_id}

server_idで識別されるサーバーの情報を取得します。

パラメーター#

Name

In

Type

Required

Description

server_id

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

正常に作成されました

Webサーバー証明書

注釈

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

put_server{server_id}#

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/server/{server_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string
import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

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

print(r.json())
const inputBody = {
  "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"
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

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

PUT /server/{server_id}

サーバー情報を更新します。

ボディパラメーター

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

パラメーター#

Name

In

Type

Required

Description

server_id

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

body

body

ServerBodyUpdate

true

なし

応答例

応答#

Status

Meaning

Description

Schema

200

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

正常に更新されました。

None

レスポンススキーマ#

注釈

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

delete_server{server_id}#

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/server/{server_id} \
  -H X-Auth-Token: string
import requests
headers = {
  X-Auth-Token: string
}

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

print(r.json())
const headers = {
  X-Auth-Token:string
};

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

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

DELETE /server/{server_id}

PEMによるサーバーの管理を停止します。

パラメーター#

Name

In

Type

Required

Description

server_id

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

None

レスポンススキーマ#

注釈

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

get_server{sid}database#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/ \
  -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/{sid}/database/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

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

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

GET /server/{sid}/database/

管理対象サーバーのデータベースのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

sid

path

integer

true

サーバーID

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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

注釈

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

get_server{sid}database{db_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name} \
  -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/{sid}/database/{db_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}

管理対象サーバーの特定のデータベースのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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

get_server{sid}database{db_name}schema#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/ \
  -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/{sid}/database/{db_name}/schema/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/

管理対象サーバーの特定のデータベースのスキーマのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}

管理対象サーバーの特定のデータベースのスキーマのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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

get_server{sid}database{db_name}schema{schema_name}table#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/table/ \
  -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/{sid}/database/{db_name}/schema/{schema_name}/table/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/table/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/table/

管理対象サーバーの特定のデータベースのスキーマにあるテーブルのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}table{table_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/table/{table_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}/table/{table_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/table/{table_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/table/{table_name}

管理対象サーバーの特定のデータベースのスキーマにあるテーブルのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

table_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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

get_server{sid}database{db_name}schema{schema_name}index#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/index/ \
  -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/{sid}/database/{db_name}/schema/{schema_name}/index/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/index/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/index/

管理対象サーバーの特定のデータベースのスキーマにあるインデックスのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}index{index_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/index/{index_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}/index/{index_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/index/{index_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/index/{index_name}

管理対象サーバーの特定のデータベースのスキーマにあるインデックスのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

index_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

get__alert_config_server_{server_id}_database_{database_name}_schema_{schema_name}_index_{index_name}

注釈

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

get_server{sid}database{db_name}schema{schema_name}sequence#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/sequence/ \
  -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/{sid}/database/{db_name}/schema/{schema_name}/sequence/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/sequence/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/sequence/

管理対象サーバーの特定のデータベースのスキーマにあるシーケンスのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}sequence{sequence_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/sequence/{sequence_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}/sequence/{sequence_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/sequence/{sequence_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/sequence/{sequence_name}

管理対象サーバーの特定のデータベースのスキーマにあるシーケンスのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

sequence_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

get__alert_config_server_{server_id}_database_{database_name}_schema_{schema_name}_sequence_{sequence_name}

注釈

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

get_server{sid}database{db_name}schema{schema_name}view#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/view/ \
  -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/{sid}/database/{db_name}/schema/{schema_name}/view/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/view/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/view/

管理対象サーバーの特定のデータベースのスキーマにあるビューのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}view{view_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/view/{view_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}/view/{view_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/view/{view_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/view/{view_name}

管理対象サーバーの特定のデータベースのスキーマにあるビューのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

view_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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

get_server{sid}database{db_name}schema{schema_name}function#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/function/ \
  -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/{sid}/database/{db_name}/schema/{schema_name}/function/, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/function/,
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/function/

管理対象サーバーの特定のデータベースのスキーマにあるファンクションのプロパティのリストを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

Status

Meaning

Description

Schema

200

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

ステータス200

Inline

レスポンススキーマ#

ステータスコード 200

Name

Type

Required

Restrictions

Description

anonymous

Query information ]

false

none

なし

» 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エージェントによって最初に検出されたときを指定します。

注釈

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

get_server{sid}database{db_name}schema{schema_name}function{function_name}#

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/function/{function_name} \
  -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/{sid}/database/{db_name}/schema/{schema_name}/function/{function_name}, headers = headers)

print(r.json())
const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/server/{sid}/database/{db_name}/schema/{schema_name}/function/{function_name},
{
  method: GET,

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

GET /server/{sid}/database/{db_name}/schema/{schema_name}/function/{function_name}

管理対象サーバーの特定のデータベースのスキーマにあるファンクションのプロパティを取得します。

パラメーター#

Name

In

Type

Required

Description

sid

path

integer

true

サーバーID

db_name

path

string

true

データベース名

schema_name

path

string

true

スキーマ名

function_name

path

string

true

なし

X-Auth-Token

header

string

true

承認トークン

応答例

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

応答#

注釈

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