WhaTap Open API

Open API

収集中のモニタリング情報を抽出して活用する場合、Open APIを通じて該当情報を抽出できる機能を提供します。アカウントのAPIトークン、プロジェクトAPIトークン、およびプロジェクトコードをパラメータとして伝達し、収集された情報を取得することができます。

旧バージョンのOpen APIドキュメントについては、次の文書を参照ください。

Open API Token確認

トークンはアカウントAPIトークンとプロジェクトAPIトークンに区分されます。アカウントAPIトークンはプロジェクトの一覧情報を取得するために活用されます。また、プロジェクトAPIトークンはプロジェクトのモニタリング情報を取得するために活用されます。

プロジェクトコードは、プロジェクトに入る際にブラウザ画面上部のウィンドウまたはタブタイトルに「[{プロジェクトコード}] Cloud Application Monitoring」のように表示される情報を通じて確認することができます。APIトークンを変更するには、各画面の再発行またはトークン再発行ボタンをクリックしてください。

区分	キー	設定値	備考
ヘッダー	`x-whatap-token`	APIトークン	アカウントAPIトークン
ヘッダー	`x-whatap-token`	APIトークン	プロジェクトAPIトークン
ヘッダー	`x-whatap-pcode`	プロジェクトコード	画面ウィンドウまたはブラウザのタブタイトルを確認してください

アカウントトークン確認

画面の右上にあるプロフィールアイコンを選択してください。
ポップアップメニューが表示されたら、アカウント管理ボタンをクリックしてください。
画面を下にスクロールし、APIトークンセクションへ移動してください。

プロジェクトトークン確認

ホーム画面からプロジェクトを選択してください。
プロジェクトに入った後、左側の管理 > プロジェクト管理メニューを選択してください。
APIトークン項目を確認してください。

プロジェク

プロジェクトリストの照会

プロジェクト一覧を照会するAPIです。

header Parameters

x-whatap-token

required

string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
accountEmail	string ユーザーアカウントのメールアドレス
total	integer プロジェクト数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/projects"

Response samples

200

Content type

application/json

{"data": [{"groupName": "",
"projectCode": 35,
"projectName": "APM_TEST2",
"createTime": "2018-10-19T07:17:03.774",
"status": "subscribe",
"productType": "APM",
"platform": "JAVA",
"gatewayName": "LOCAL",
"apiToken": "5**********************R"
}
],
"accountEmail": "xxx@whatap.io",
"total": 6
}

プロジェクト情報照会

アプリケーションおよびサーバー製品のプロジェクト情報を照会するAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

One of

platform	string アプリケーション製品プラットフォーム
createTime	string プロジェクト作成日
gatewayName	string データサーバーリージョン
projectCode	number プロジェクトコード
status	string Enum: "pending" "trial" "有償転換" "close_pending" "limited" "closed" "trial_limited" プロジェクトステータス
lastUpdatedTime	string プロジェクト編集日
name	string プロジェクト名
productType	string アプリケーション製品タイプ

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/project"

Response samples

200

Content type

application/json

Example

Application

{"platform": "JAVA",
"createTime": "Tue Sep 18 08:34:27 GMT 2018",
"gatewayName": "Office-OTE",
"projectCode": 1234,
"status": "Subscribe",
"lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018",
"name": "SEO_APM",
"productType": "APM"
}

プロジェクトメンバー一覧を参照

プロジェクトに所属するメンバーの一覧を照会するAPIです。

path Parameters

projectCode

required

integer

プロジェクトコード

header Parameters

x-whatap-token

required

string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer プロジェクトメンバー数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/project/{projectCode}/members"

Response samples

200

Content type

application/json

{"data": [{"email": "honggildong@whatap.io",
"name": "Hong",
"desc": "",
"sms": "010XXXXXXX"
}
],
"totla": 8
}

グループ

グループ一覧の表示

ユーザーが所属するグループの一覧を照会するAPIです。

header Parameters

x-whatap-token

required

string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer グループ数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/v2/json/groups"

Response samples

200

Content type

application/json

{"data": [{"groupName": "WHATAP APM",
"groupKey": "grp****ab123kskd*****q",
"description": "APM Group"
}
],
"total": 3
}

グループメンバーのリストを表示

ユーザーが所属するグループのメンバー一覧を照会するAPIです。

path Parameters

groupKey

required

integer

グループ固有識別子(ID)

header Parameters

x-whatap-token

required

string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer グループメンバー数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/group/{groupKey}/members"

Response samples

200

Content type

application/json

{"data": [{"email": "honggildong@whatap.io",
"name": "홍길동",
"desc": "",
"sms": "010XXXXXXX"
}
],
"totla": 8
}

グループに含まれるプロジェクトを表示

グループに含まれたプロジェクトのメタ情報を照会するAPIです。

path Parameters

groupKey

required

integer

グループ固有識別子(ID)

header Parameters

x-whatap-token

required

string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

Array of objects

Array

projectCode	integer プロジェクトコード
name	string プロジェクト名
status	string Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited" プロジェクトステータス
productType	string プロジェクトの製品タイプ
platform	string プロジェクトの製品プラットフォーム
gatewayName	string データサーバーリージョン

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/group/{groupKey}/projects"

Response samples

200

Content type

application/json

{"data": [{"projectCode": 35,
"name": "APM_TEST2",
"status": "Subscribe",
"productType": "APM",
"platform": "JAVA",
"gatewayName": "LOCAL"
}
]
}

エージェント

エージェント状態とホストIP照会

プロジェクト内のエアジェントの状態およびIPアドレスを照会するAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

Array of objects

Array

host_ip	string <ipv4> IPアドレス
oname	string エージェント名
active	boolean エージェントの活性化状態の有無

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/agents"

Response samples

200

Content type

application/json

{"data": [{"host_ip": "127.0.0.1",
"oname": "TC-29-96-8082",
"active": true
}
]
}

oid一覧呼び出し

ユーザーが表示したい時間帯を有効になっているエージェント情報を確認できるAPIです。照会時間(stime、etime)は一日に制限され、時間単位はms(millisecond、ms)です。

例示で作成されたサンプルコードのうち、stime、etimeのパラメータ値は、ユーザー環境に合わせて変更して利用してください。パラメータ値は、様々なフォーマットに変更してリクエストできます。

1693475430087 (unix timestamp)
yyyyMMddHHmmss
yyyyMMddHHmm
MMddHHmmss
MMddHHmm

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request Body schema: application/json
required

stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

Responses

Response Schema: application/json

stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timestamp	integer <int64> データ生成時間(UNIX epoch time、millisecond)
	Array of objects

Request samples

Payload
curl

Content type

application/json

{"stime": 1690850183000,
"etime": 1693321200000
}

Response samples

200

Content type

application/json

{"stime": 1690850183000,
"etime": 1693321200000,
"timestamp": 1693388196965,
"data": [{"oid": 757639646,
"oname": "DBX-0-107-3306",
"alias": "",
"initial": "",
"otype": "database",
"subtype": "0",
"active": false,
"okind": 0,
"okindName": "",
"onode": 0,
"onodeName": "",
"ip": "",
"agent.version": "",
"cpuCores": 0
}
]
}

APM Spot情報照会

アプリケーションモニタリングプロジェクトのエージェント情報および関連指標を照会できるAPIの一覧を案内します。

すべての情報照会

アプリケーションモニタリングプロジェクトのすべての情報を照会するAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
act_agent	string アクティブ状態のエージェント数
inact_agent	string 非アクティブ状態のエージェント数
host	string ホスト(HOST) 数
cpucore	string ホストのCPUコア数の合計
txcount	string トランザクション数
tps	string TPS
user	string アクティブユーザー（5分）
actx	string アクティブトランザクション
rtime	string 平均リスポンスタイム(ms)
cpu	string CPU使用率の平均(%)
threadpool_active	string スレッドプールのアクティブスレッド数
threadpool_queue	string スレッドプールのキューイングスレッド数
dbconn_total	string 全体DB Connection数
dbconn_act	string アクティブ(Active) 状態のDB Connection数
dbconn_idle	string 遊休(Idle) 状態のDB Connection数
act_method	string 活性メソッド(Method) 数
act_sql	string 活性SQL数
act_httpc	string 活性HTTP Call数
act_dbc	string 活性データベースコネクション数
act_socket	string 活性ソケット(Socket) 接続数
apdex	string Apdex(Application Performance Index、アプリケーションのユーザー満足度)

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/json/spot"

Response samples

200

Content type

application/json

{"pcode": 8,
"act_agent": "6",
"inact_agent": "6",
"host": "1",
"cpucore": "2",
"txcount": "459",
"tps": "93.07",
"user": "1007",
"actx": "149",
"rtime": "1873",
"cpu": "29.35",
"threadpool_active": "0",
"threadpool_queue": "0",
"dbconn_total": "600.0",
"dbconn_act": "239.0",
"dbconn_idle": "361.0",
"act_method": "51",
"act_sql": "24",
"act_httpc": "64",
"act_dbc": "10",
"act_socket": "0",
"apdex": "0.9871"
}

アクティブ状態のエージェント数の照会

アプリケーションモニタリングプロジェクトで活性化状態のエージェント数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

アクティブ状態のエージェント数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/act_agent"

Response samples

200

Content type

text/plain

非アクティブ状態のエージェント数の照会

アプリケーションモニタリングプロジェクトで非活性化状態のエージェント数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

非アクティブ状態のエージェント数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/inact_agent"

Response samples

200

Content type

text/plain

ホスト(HOST) 数

アプリケーションモニタリングプロジェクトに接続されたホスト(HOST) の数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

ホスト(HOST) 数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/host"

Response samples

200

Content type

text/plain

ホストCPUコアの合計

アプリケーションモニタリングプロジェクトに接続されたホスト(HOST) のCPUコア合計を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

CPUコア数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/cpucore"

Response samples

200

Content type

text/plain

TX数

アプリケーションモニタリングプロジェクトでトランザクション数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

TX数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/txcount"

Response samples

200

Content type

text/plain

TPS

アプリケーションモニタリングプロジェクトで1秒あたりに処理されたトランザクション数(Transaction per second、TPS)を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number <float>

1秒間に処理されたトランザクション件数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/tps"

Response samples

200

Content type

text/plain

92.03

アクティブユーザー（5分）

アプリケーションモニタリングプロジェクトで最近5分以内にトランザクションを発生させたユーザーを測定した同時接続ユーザーを照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

5分間のリアルタイムユーザー数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/user"

Response samples

200

Content type

text/plain

アクティブトランザクション

アプリケーションモニタリングプロジェクトでアクティブトランザクション数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

アクティブトランザクション数

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/actx"

Response samples

200

Content type

text/plain

平均応答時間

アプリケーションモニタリングプロジェクトで平均リスポンスタイムを照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

integer

平均応答時間

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/rtime"

Response samples

200

Content type

text/plain

CPU使用率の平均

アプリケーションモニタリングプロジェクトで平均CPU使用率を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number <float>

CPU使用率の平均

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/cpu"

Response samples

200

Content type

text/plain

9.26

Apdex

アプリケーションモニタリングプロジェクトでApdex(Application Performance Index、アプリケーションのユーザー満足度)を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number <float>

Apdex

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/apdex"

Response samples

200

Content type

text/plain

0.9871

APM統計データの参照

アプリケーションモニタリングプロジェクトの統計データを照会できるAPIの一覧を案内します。

Exception

アプリケーションモニタリングプロジェクトで設定した時間中、Exception処理された履歴を照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer 全体例外レコード数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/exception/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"oids": "[-1459620666]",
"time": 1535557500000,
"classHash": -1811136020,
"count": 14,
"service": "/account/delete/dept/daegu",
"class": "java.sql.SQLException(0)",
"serviceHash": 1900616259,
"snapSeq": "6068699991557528332",
"msg": "Sql Exception"
}
],
"total": 2063
}

HTTP外部呼び出し

アプリケーションモニタリングプロジェクトで設定した時間中、HTTP外部呼び出し履歴を照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer 合計HTTP接続レコード数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/httpc/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"Sum": 22628,
"Port": 10002,
"Url": "/remote/account/save/employee/kwangju",
"Host": "127.0.0.1",
"Max": 1815,
"Stdev": "247.95",
"Actived": 0,
"Avg": 1131,
"HostHash": -675813464,
"Min": 1002,
"Error": 0,
"Total": 20,
"UrlHash": -243814510
}
],
"total": 4923
}

HTTP外部呼び出しフィルタリング

アプリケーションモニタリングプロジェクトで設定した時間中、HTTP外部呼び出し履歴をホストのアドレスとポート番号を基準にフィルタリングして照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
host required	string フィルタリングするホストアドレス
port required	string フィルタリングするホストポート番号

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer 合計HTTP接続レコード数

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/httpc/{stime}/{etime}/filter/host/{host}/port/{port}"

Response samples

200

Content type

application/json

{"records": [{"Service": "/sales/remove/unit/kwangju",
"Host": "127.0.0.1",
"HostHash": -675813464,
"Avg": 1080,
"Error": 0,
"Sum": 2411644,
"Port": 10007,
"Service_hash": -1003301916,
"Url": "/remote/account/save/employee/seoul",
"Max": 2442,
"Stdev": "159.01",
"UrlHash": 180997672,
"Total": 2233,
"Min": 1001
},
{"Service": "/product/delete/employee/daejun",
"Host": "127.0.0.1",
"HostHash": -675813464,
"Avg": 1085,
"Error": 0,
"Sum": 2075036,
"Port": 10007,
"Service_hash": 2100205994,
"Url": "/remote/account/save/employee/pusan",
"Max": 2462,
"Stdev": "173.06",
"UrlHash": -924053750,
"Total": 1911,
"Min": 1001
}
],
"total": 1080
}

SQL

アプリケーションモニタリングプロジェクトで設定した時間中、SQL文を照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer SQLクエリレコードの合計数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/sql/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"time_max": 4164,
"dbcHash": 450678784,
"db": "jdbc:mysql://localhost:3306,localhost:3310/fake",
"time_min": 0,
"fetch_count": 0,
"hash": 796628118,
"fetch_time": 0,
"sql_crud": 0,
"count_total": 5224,
"count_error": 0,
"sql": "update table set x=# where key=#",
"time_sum": 581391,
"time_avg": 111,
"time_std": "240.79",
"count_actived": 0
}
],
"total": 130
}

Client IP

アプリケーションモニタリングプロジェクトで設定した時間中、遠隔クライアントIPを照会できるAPIです。 WhaTapは、クライアントに関する情報をデフォルトで保存します。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer リモートクライアントのIPレコードの合計数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/remote/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"count": 86,
"city": "Winnipeg",
"country": "CA (CANADA)",
"ip": "140.193.83.68"
}
],
"total": 1000
}

トランザクション

アプリケーションモニタリングプロジェクトで設定した時間中、発生したトランザクション履歴を照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects
total	integer トランザクションレコードの合計数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/transaction/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"apdex_tolerated": 98,
"apdex_satisfied": 279,
"apdex": 0.830379746835443,
"time_max": 44735,
"sql_fetch_time": 363,
"sql_time": 2628663,
"count": 10743,
"error": 29,
"sql_count": 22635,
"hash": -1485863373,
"sql_fetch": 6741607,
"httpc_avg": 1084,
"cpu_avg": 0,
"time_sum": 19911778,
"time_avg": 1853,
"httpc_count": 7072,
"service": "/account/save/employee/seoul",
"mem_avg": 0
}
],
"total": 1080
}

Heap使用量 - 統計平均値

アプリケーションモニタリングプロジェクトで設定した時間中、Heap使用量に対する統計平均値を照会できるAPIです。照会時間は1時間以内に制限し、ミリ秒(millisecond、ms) 単位です。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge	string データ集計方式(avgまたはmax)
unit	string Heap使用量単位(例、byte)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/heap_use/{stime}/{etime}/avg"

Response samples

200

Content type

application/json

{"pcode": 5490,
"stime": 1677747600000,
"etime": 1677749594269,
"timeMerge": "avg",
"unit": "byte",
"data": [{"oid": -1143239575,
"oname": "demo-8101",
"heap_use": "36121554.72"
},
{"oid": -857948929,
"oname": "demo-8105",
"heap_use": "37498925.139"
}
]
}

Heap使用量 - 統計最大値

アプリケーションモニタリングプロジェクトで設定した時間中、Heap使用量に対する統計最大値を照会できるAPIです。照会時間は1時間以内に制限し、ミリ秒(millisecond、ms) 単位です。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge	string データ集計方式(avgまたはmax)
unit	string Heap使用量単位(例、byte)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/heap_use/{stime}/{etime}/max"

Response samples

200

Content type

application/json

{"pcode": 5490,
"stime": 1677747600000,
"etime": 1677749594269,
"timeMerge": "max",
"unit": "byte",
"data": [{"oid": -1143239575,
"oname": "demo-8101",
"heap_use": "36121554.72"
},
{"oid": -857948929,
"oname": "demo-8105",
"heap_use": "37498925.139"
}
]
}

エージェントデータ照会

アプリケーションモニタリングプロジェクトで設定した時間中、エージェント全体のデータを照会できるAPIです。

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 照会できる指標
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
interval	integer データポイント間隔(秒)
timeMerge	string データ集計方式(sum)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objects": [{"oname": "8080",
"oid": -1234257485,
"series": [[1536050100000,
95.2
],
[1536050400000,
85.3
],
[1536050700000,
91.43
]
]
},
{"oname": "TC-29-96-8082",
"oid": 1482741919,
"series": [[1536050100000,
98.11
],
[1536050400000,
81.44
],
[1536050700000,
90.05
]
]
}
]
}

エージェント平均データ照会

アプリケーションモニタリングプロジェクトで設定した時間中、エージェント全体の平均データを照会できるAPIです。

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 照会できる指標
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
interval	integer データポイント間隔(秒)
timeMerge	string データ集計方式(sum)
objectMerge	string データマージ方式(avg)
	Array of items

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/avg"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objectMerge": "avg",
"series": [[1536050100000,
122.86
],
[1536050400000,
99.26
],
[1536050700000,
109.68
]
]
}

指定エージェントデータ照会

アプリケーションモニタリングプロジェクトで設定した時間中、指定したエージェント(oids)のスレッド数データを照会できるAPIです。エージェント(oids)は、コンマ(,)を区切り記号として複数指定できます。

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
oids required	integer <int32> エージェント固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 照会できる指標
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
interval	integer データポイント間隔(秒)
timeMerge	string データ集計方式(sum)
	Array of objects

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/{oids}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objects": [{"oname": "8080",
"oid": -1234257485,
"series": [[1536050100000,
95.2
],
[1536050400000,
85.3
],
[1536050700000,
91.43
]
]
},
{"oname": "TC-29-96-8082",
"oid": 1482741919,
"series": [[1536050100000,
98.11
],
[1536050400000,
81.44
],
[1536050700000,
90.05
]
]
}
]
}

指定エージェント平均データ照会

アプリケーションモニタリングプロジェクトで設定した時間中、指定したエージェント(oids)の平均データを照会できるAPIです。エージェント(oids)は、コンマ(,)を区切り記号として複数指定できます。

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 照会できる指標
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
interval	integer データポイント間隔(秒)
timeMerge	string データ集計方式(sum)
objectMerge	string データマージ方式(avg)
	Array of items

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/avg/{oids}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objectMerge": "avg",
"series": [[1536050100000,
117.49
],
[1536050400000,
100.26
],
[1536050700000,
120.2
]
]
}

5分単位のアクティブユーザー照会

アプリケーションモニタリングプロジェクトで設定した時間中、5分単位の同時接続ユーザーを照会できるAPIです。同時接続ユーザーは、最近5分以内にトランザクションを発生させたユーザーを測定した値です。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of items
pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
total	integer 合計訪問者数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_5m/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554444005000,
12
],
[1554444010000,
12
]
],
"pcode": 3000000079,
"stime": 1554444000000,
"etime": 1554444300000,
"total": 59
}

1時間単位のアクティブユーザー照会

アプリケーションモニタリングプロジェクトで設定した時間中、1時間単位の同時接続ユーザーを照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of items
pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
total	integer 合計訪問者数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_h/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554444000000,
18
],
[1554444010000,
16
]
],
"pcode": 3000000079,
"stime": 1554444000000,
"etime": 1554454800000,
"total": 59
}

1日単位のアクティブユーザー照会

アプリケーションモニタリングプロジェクトで設定した時間中、1日単位の同時接続ユーザーを照会できるAPIです。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of items
pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
total	integer 合計訪問者数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_d/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554163200000,
1007
],
[1554249600000,
1007
],
[1554336000000,
1007
]
],
"pcode": 3000000079,
"stime": 1554163200000,
"etime": 1554422400000,
"total": 3
}

1ヵ月単位のアクティブユーザー照会

アプリケーションモニタリングプロジェクトで設定した時間中、1ヵ月単位の同時接続ユーザーを照会できるAPIです。 1ヶ月間集計された固有ユーザー統計で、etimeはstimeを基準に365日を超えることはできません。

path Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects 各月ごとのユーザー統計データ
pcode	integer プロジェクトコード
stime	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
sdate	string 照会開始時間の文字列表現
edate	string 照会終了時間の文字列表現
total	integer 合計訪問者数

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_m/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [{"stime": 1535760000000,
"etime": 1538352000000,
"sdate": "Sat Sep 01 00:00:00 GMT 2018",
"edate": "Mon Oct 01 00:00:00 GMT 2018",
"mau": 1007
},
{"stime": 1538352000000,
"etime": 1541030400000,
"sdate": "Mon Oct 01 00:00:00 GMT 2018",
"edate": "Thu Nov 01 00:00:00 GMT 2018",
"mau": 1007
}
],
"pcode": 1234570141,
"stime": 1535760000000,
"etime": 1541030400000,
"sdate": "Sat Sep 01 00:00:00 GMT 2018",
"edate": "Thu Nov 01 00:00:00 GMT 2018",
"total": 2
}

呼出統計フィルタリング

プロジェクト間のトランザクション呼び出しの統計またはトランザクションドメイン呼び出しの統計をフィルタリングして照会できます。

filterkey：照会条件キー(caller_pcode, caller_spec (バージョン), caller_url, spec (バージョン), url)
filterval：照会条件(filterkeyが caller_url または urlの場合、base64でエンコード)

path Parameters

metric_type	string Enum: "tx_caller" "tx_domain" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
filterkey required	string Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url" 照会条件キー
filterval required	string 照会条件(`filterkeyが` `caller_url`または`url`の場合、base64としてエンコード)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/filter/{filterkey}/{filtereval}"

指定エージェント呼び出し統計フィルタリング

指定したエージェントを基準にプロジェクト間のトランザクション呼び出しの統計またはトランザクションドメイン呼び出しの統計をフィルタリングして照会できます。

filterkey：照会条件キー(caller_pcode, caller_spec (バージョン), caller_url, spec (バージョン), url)
filterval：照会条件(filterkeyが caller_url または urlの場合、base64でエンコード)

path Parameters

metric_type	string Enum: "tx_caller" "tx_domain" 照会できる指標
stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
oids required	integer <int32> エージェント固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能
filterkey required	string Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url" 照会条件キー
filterval required	string 照会条件(`filterkeyが` `caller_url`または`url`の場合、base64としてエンコード)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/{oids}/filter/{filterkey}/{filtereval}"

TPS

アプリケーションモニタリングプロジェクトで設定した時間の間TPS(Transaction Per Second) データを照会できるAPIです。

query Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge required	string Value: "avg" データ集計方式

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number <float>

TPS数

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/raw/tag/app_counter/tps?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

66.0

平均応答時間

アプリケーションモニタリングプロジェクトで設定した時間中、平均リスポンスタイムを照会できるAPIです。

query Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge required	string Value: "avg" データ集計方式

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number

平均応答時間

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/raw/tag/app_counter/resp_time?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

CPU使用率の平均

アプリケーションモニタリングプロジェクトで設定した時間中、平均CPU使用率を照会できるAPIです。

query Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge required	string Value: "avg" データ集計方式

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain

number

CPU使用率の平均

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/raw/tag/app_host_resource/cpu?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

11.50

データソースあたりのDB Connection数

アプリケーションモニタリングプロジェクトで設定した時間中、データソース別DB Connection数を照会できるAPIです。

query Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
timeMerge required	string Value: "avg" データ集計方式

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
time	integer <int64> 検索時間
	Array of objects (ConnectionDetail)

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/tag/db_pool_detail/dbconn?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

application/json

{"pcode": 35,
"time": 1554163200000,
"dbc_total": [{"oid": -963710734,
"oname": "TC-29-96-8082",
"databaseUrl": "jdbc:db:virtual",
"active": 49,
"idle": 51,
"total": 100
}
]
}

データソースあたりのDB Connection数 - 短期照会

アプリケーションモニタリングプロジェクトで終了時間を基準にデータソース別DB Connection数を照会できるAPIです。

query Parameters

etime

required

integer <int64>

照会終了時間(UNIX epoch time、millisecond)

header Parameters

x-whatap-token required	string アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
time	integer <int64> 検索時間
	Array of objects (ConnectionDetail)

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/tag/db_pool_detail/dbconn?etime={etime}"

Response samples

200

Content type

application/json

{"pcode": 17,
"time": 1667467012037,
"dbc_total": [{"oid": -959062357,
"oname": "TC-0-1-8087",
"databaseUrl": "jdbc:db:virtual",
"active": 63,
"idle": 37,
"total": 100
},
{"oid": -1311576515,
"oname": "TC-0-1-8086",
"databaseUrl": "jdbc:db:virtual",
"active": 10,
"idle": 90,
"total": 100
}
]
}

IPベースのトランザクション検索

ユーザーが指定した開始時間(stime)から1時間、特定IPがリクエストしたトランザクションに対して呼び出し件数の多い順にソートして最大100件のURLリストを送信するAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request Body schema: application/json
required

type	string
path	string
pcode	string プロジェクトコード
	object

Responses

Response Schema: application/json

elapsed	number 開始時間(`stime`) 基準からの経過時間
count	number HTTPコール件数
url	string クライアントがリクエストしたトランザクション名

Request samples

Payload
curl

Content type

application/json

{"type": "profiles",
"path": "/filter/search",
"pcode": "12345",
"params": {"stime": 1690850183000,
"filter": {"ip": "10.11.12.13"
}
}
}

Response samples

200

Content type

application/json

{"elapsed": 0,
"count": 0,
"url": "string"
}

Server Spot情報照会

サーバーモニタリングプロジェクトのエージェント情報および関連指標を照会できるAPIの一覧を案内します。

アクティブ状態のエージェント数の照会

サーバーモニタリングプロジェクトで活性化状態のエージェント数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pname	string プロジェクト名
values	string カウント

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/act_agent"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "57.0"
}

非アクティブ状態のエージェント数の照会

サーバーモニタリングプロジェクトで非活性化状態のエージェント数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pname	string プロジェクト名
values	string カウント

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/inact_agent"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "4.0"
}

ホスト(HOST) 数

サーバーモニタリングプロジェクトに接続されたホスト(HOST) の数を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pname	string プロジェクト名
values	string カウント

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/host"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "57.0"
}

ホストCPUコアの合計

サーバーモニタリングプロジェクトに接続されたホスト(HOST) のCPUコア合計を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pname	string プロジェクト名
values	string カウント

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/cpucore"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "108.0"
}

CPU使用率

サーバーモニタリングプロジェクトに接続されたホスト(HOST)のCPU使用率を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
pname	string プロジェクト名
timezone	integer タイムゾーン
regionName	string データサーバーリージョン
	object サーバー別CPU使用率(%)
language	string 警告通知の言語

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_cpu"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": 0.9009018,
"php-official-demo": 1.6949158,
"python-demo-attacker": 0.50099945,
"virtual-java-agent": 55.08919
},
"language": "en"
}

ディスクIOPSの合計

サーバモニタリングプロジェクトに接続されたホスト(HOST)のディスクIOPSの合計を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
pname	string プロジェクト名
timezone	integer タイムゾーン
regionName	string データサーバーリージョン
	object
language	string 警告通知の言語

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_disk_iops"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": {"bps": 8208.67,
"iops": 1.402849
},
"php-official-demo": {"bps": 3951.273,
"iops": 0.771733
},
"python-demo-attacker": {"bps": 7376.34,
"iops": 1.00048
},
"virtual-java-agent": {"bps": 6563.1836,
"iops": 0.40058494
}
},
"language": "en"
}

ネットワークトラフィック（IN／OUT）の合計

サーバモニタリングプロジェクトに接続されたホスト(HOST)のネットワークトラフィック(IN/OUT)の合算を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
pname	string プロジェクト名
timezone	integer タイムゾーン
regionName	string データサーバーリージョン
	object
language	string 警告通知の言語

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_net_traffic"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": 128204.76878652698,
"python-demo-attacker": 16231.465016029671,
"virtual-java-agent": 10820618.160992496
},
"language": "en"
}

プロセス状況

サーバモニタリングプロジェクトに接続されたホスト(HOST)のプロセス状況を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pname	string プロジェクト名
	object
language	string 警告通知の言語

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_proc"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": {"s-p-gtw-03": [{"memoryBytes": 1274269696,
"bps": 819.2,
"cmd1": "java",
"cpu": 2.8507125
},
{"memoryBytes": 2895872,
"bps": 0,
"cmd1": "rsyslogd",
"cpu": 0
}
],
"t-a-yrd-01": [{"memoryBytes": 2583621632,
"bps": 1175961.5,
"cmd1": "java",
"cpu": 10.621243
}
]
}
}

サーバーリスト

サーバーモニタリングプロジェクトのサーバー一覧を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
pname	string プロジェクト名
timezone	integer タイムゾーン
regionName	string データサーバーリージョン
	Array of objects
language	string 警告通知の言語

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/sm_servers"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": [{"os.status": "warning",
"oname": "php-official-demo",
"os.name": "linux",
"oid": -1413588424,
"isActive": true
},
{"os.status": "ok",
"oname": "dotnet-official-demo",
"os.name": "windows",
"oid": -1755389652,
"isActive": true
},
{"os.status": "ok",
"oname": "mysql-official-demo-02",
"os.name": "linux",
"oid": -1816982090,
"isActive": true
}
],
"language": "en"
}

サーバーモニタリングの詳細

サーバーモニタリングプロジェクトの各サーバー別の詳細情報を照会できるAPIです。

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/sm"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": {"servers": [{"public_ip": "192.168.0.1",
"os_cpuvendor": "Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz",
"agent_created": "49572130779",
"ip": "127.0.0.1,10.128.0.1",
"os_arch": "amd64",
"actTime": 1570672662216,
"cpu_cores": "1",
"oid": -1359816680,
"isActive": true,
"version": "1.2.5",
"tags": ["gateway",
"python",
"network:10.0.0.0/8",
"@PRX"
],
"inactTime": 0,
"oname": "h-db-prx-01",
"os_name": "linux",
"startTime": 1570672662000,
"os_memory": "2088476672",
"os_status": "ok",
"snapshot": {"disk": {"/boot": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/boot",
"queueLength": 0,
"usedSpace": 58863616,
"blksize": 4096,
"freeSpace": 841175040,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 966778880,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda1",
"usedPercent": 6.540122985839844,
"freePercent": 93.45987701416016,
"writeBps": 0,
"readIops": 0
},
"/home": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/home",
"queueLength": 0,
"usedSpace": 1670574080,
"blksize": 4096,
"freeSpace": 69533446144,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 75039498240,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda3",
"usedPercent": 2.3461761474609375,
"freePercent": 97.65382385253906,
"writeBps": 0,
"readIops": 0
},
"/": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/",
"queueLength": 0,
"usedSpace": 5079060480,
"blksize": 4096,
"freeSpace": 22798901248,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 29394726912,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda2",
"usedPercent": 18.218902587890625,
"freePercent": 81.78109741210938,
"writeBps": 0,
"readIops": 0
}
},
"memory": {"shared": 21590016,
"swapused": 0,
"buffers": 182550528,
"available": 1746370560,
"swaptotal": 0,
"used": 342106112,
"pused": 16.380653381347656,
"slab": 85729280,
"total": 2088476672,
"sunreclaim": 23261184,
"cached": 521756672,
"pavailable": 83.61934661865234,
"pagefaults": 0,
"sreclaimable": 62468096,
"free": 1167208448,
"swappused": 0
},
"cpu": {"softirq": 0,
"usr": 0,
"idle": 100,
"steal": 0,
"irq": 0,
"load5": 0,
"iowait": 0,
"sys": 0,
"nice": 0,
"load1": 0,
"load15": 0
},
"open_filedescriptors": 249,
"netstat": {"established": 1,
"syn_sent": 1,
"syn_recv": 0,
"closing": 0,
"time_wait": 19,
"last_ack": 0,
"fin_wait1": 0,
"close_wait": 0,
"fin_wait2": 0,
"listen": 3,
"unknown": 0
},
"uptime": 16313689,
"network": {"lo": {"errorOut": 0,
"packetOut": 0.3991734786600438,
"trafficIn": 281.0181289766709,
"trafficOut": 281.0181289766709,
"hwAddr": "",
"errorIn": 0,
"ip": "127.0.0.1",
"count": 1,
"droppedIn": 0,
"droppedOut": 0,
"packetIn": 0.3991734786600438,
"desc": "lo"
},
"eth0": {"errorOut": 0,
"packetOut": 8.1830563125309,
"trafficIn": 11314.173079140282,
"trafficOut": 19447.731880317337,
"hwAddr": "00:1d:d8:b7:87:18",
"errorIn": 0,
"ip": "10.128.112.133",
"count": 1,
"droppedIn": 0,
"droppedOut": 0,
"packetIn": 24.549168937592693,
"desc": "eth0"
}
}
}
}
],
"max": {"disk": {"writeIops": 240.9893,
"usedPercent": 94.38699,
"freePercent": 100,
"usedSpace": 2464956810000,
"freeSpace": 0,
"writeBps": 2917852,
"readBps": 118646.15,
"readIops": 75.80727,
"totalSpace": 9223372000000000000,
"ioPercent": 100,
"freespace": 158926471000
},
"nic": {"errorOut": 0,
"packetOut": 2175.8743,
"trafficIn": 4856648,
"trafficOut": 2503208.8,
"errorIn": 1,
"droppedIn": 1,
"droppedOut": 0,
"packetIn": 2175.8743
},
"compound_eye_traffic": 1000000000
},
"count": {"total": 14,
"paused": 0,
"inactive": 0,
"warning": 1,
"ok": 13,
"close": 0,
"fatal": 0
},
"tags": { }
}
}

Server統計データの参照

サーバーモニタリングプロジェクトの統計データを照会できるAPIの一覧を案内します。

サーバー統計の詳細

サーバーモニタリングプロジェクトの統計データを照会できるAPIです。照会時間は1時間以内に制限し、ミリ秒(millisecond、ms) 単位です。

filter：デフォルト値はm5であり、時間範囲内で5分の統計を照会するにはm5、5秒の統計はs5, 1時間の統計はh1を入力してください。
oid：特定のエージェントを指定して照会する場合は、追加してください。

oid以外のパラメータは適用できません。

query Parameters

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
filter required	string Enum: "m5" "s5" "h1"
oid required	integer <int32> エージェント固有識別子(ID)

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

Array of objects

Array

oid	integer エージェント固有識別子(ID)
	Array of objects

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/json/stat/sm_stat?{stime}&{etime}&{filter}&{oid}"

Response samples

200

Content type

application/json

{"servers": [{"oid": -1030311093,
"timeData": [{"usedPercent": 69.1,
"trafficIn": 12113.57,
"trafficOut": 24781.08,
"cpu": 4.08,
"memory_swappused": 15.41,
"time": 1572341400000,
"memory_pused": 47.6,
"ioPercent": 0.26
},
{"usedPercent": 69.1,
"trafficIn": 12183.97,
"trafficOut": 25600.59,
"cpu": 7.89,
"memory_swappused": 15.5,
"time": 1572341700000,
"memory_pused": 47.79,
"ioPercent": 0.22
}
]
}
]
}

Databaseパラメータ参照

データベースのパラメータの関連事項を照会できます。

パラメータ変更事項照会

データベースのパラメータの変更を照会できます。

query Parameters

oid required	integer <int32> エージェント固有識別子(ID)
baeTime required	string <yyyyMMdd> 基準時間
comparisonTime required	string <yyyyMMdd> 比較時間

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: applciation/json

	Array of objects (UnmatchedKey) 基準時間と比較時間で一致しないキーとその値
	Array of objects (MatchedParameter) 基準時間でのパラメータ一覧
	Array of objects (MatchedParameter) 比較時間でのパラメータの一覧

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/db/database_params?oid={oid}&baseTime={baseTime}&comparisonTime={comparisonTime}"

Response samples

200

Content type

applciation/json

{"unmatchedKeys": [{"key": "Innodb_buffer_pool_load_status(stat)",
"value": {"baseTime": "Buffer pool(s) load completed at 230818  2:54:51",
"comparisonTime": "Buffer pool(s) load completed at 230810  6:05:50"
}
},
{"key": "Max_used_connections_time(stat)",
"value": {"baseTime": "2023-08-18 23:54:51",
"comparisonTime": "2023-08-10 06:05:51"
}
}
],
"baseTime": [{"key": "activate_all_roles_on_login",
"value": "OFF"
},
{"key": "admin_address",
"value": ""
}
],
"comparisonTime": [{"key": "activate_all_roles_on_login",
"value": "OFF"
},
{"key": "admin_address",
"value": ""
}
]
}

Database SQL照会

データベースのSQL関連事項を照会できます。

SQL統計TopN

設定した時間中、最も多く利用されたSQL統計情報を照会できます。

query Parameters

oids required	integer <int32> エージェント固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能
period required	string Enum: "day" "weak" 照会期間
date required	string <yyyyMMdd> 基準時間
topN	number <1 -1000> Default: 10 上位件数
order	string Default: "sql_execute_cnt" Enum: "sql_execute_cnt" "sql_elapse" "sql_elapse_max" ソート順
category	string Default: "ALL" Enum: "ALL" "DB" "HOST" "USER" カテゴリーを`USER`で選択すると、ユーザー基準でSQL統計データをレスポンス
nameInCategory	string パラメータで`category`を選択すると追加

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json

	Array of objects (SqlRecord)
topN	integer リクエストされたTopN値
total	integer 全体記録されたSQL一覧数
retrievedStartTime	integer <int64> 照会期間の開始時間
retrievedEndTime	integer <int64> 照会期間の終了時間

Request samples

curl

curl -L \

-w "\n" \

-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \

-H "x-whatap-pcode: {{projectCode}}" \

"https://api.whatap.io/open/api/json/db/statistics/sql?oids={oids}&period={period}&date={date}"

Response samples

200

Content type

application/json

{"records": [{"sql_execute_cnt": 33863,
"sql_elapse": 643,
"sqlHash": 1559625025,
"sql_elapse_max": 5,
"onames": "DBX-0-102-3306,DBX-0-162-3306",
"user": "kwlee",
"sql": "select /* WhaTap6D#5 */ * from\ninformation_schema.processlist where command<>'#'"
},
{"sql_execute_cnt": 28387,
"sql_elapse": 0,
"sqlHash": -499643965,
"sql_elapse_max": 0,
"onames": "DBX-0-107-3306",
"user": "whatap",
"sql": "select\nid,user,host,db,command,time,state,info,time_ms,stage,max_stage,progress,\nmemory_used,max_memory_used,examined_rows,query_id,tid\nfrom information_schema.processlist where command<>'#' and\ncommand<>'#'"
}
],
"topN": 10,
"total": 129,
"retrievedStartTime": 1692921600000,
"retrievedEndTime": 1693007999000
}

MXQL Open API 的な使い方

MXQLを使用する方法は次のとおりです。

直接MXQLクエリを作成してデータを表示する方法
次の文書を使用して、「SaaSサービスで提供する事前に定義されたMXQLクエリの一覧」でデータを参照する方法

したがって、それぞれの場合に使用されるAPIのパスが異なります。

MXQL使用方法	API
直接MXQLクエリを作成する場合	MXQL text API
「SaaSサービスで提供する事前に定義されたMXQLクエリの一覧」を使用する場合、(次の文書参照)	MXQL path API

OpenAPIの呼び出し時、ヘッダーに含まれる内容は次のとおりです。

区分	キー	設定値	備考
ヘッダー	x-whatap-token	APIトークン `{{PROJECT API TOKEN}}`	プロジェクトAPIトークン：プロジェクト選択 > 管理 > プロジェクト管理 > APIトークン
ヘッダー	x-whatap-pcode	プロジェクトコード `{{projectCode}}`	プロジェクトコード：プロジェクト選択 > 管理 > プロジェクト管理 > プロジェクトコード

MXQL Open APIの制限事項

一度のリクエストで照会できる期間は最大31日です。

MXQL Open API を呼び出す

MXQL text API

次の図は、MXQL実行結果の例です。

MXQL実行結果の例

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request Body schema: application/json
required

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
mql required	string 作成したMXQLクエリ
limit required	integer 最大データ参照数
pageKey required	string 文字列 `mxql`の固定値
	object 次の文書参照例）`{ "default": "ORDER {key : [oid], sort : [desc] }"}`
	object 次の文書参照例）`{ "$oidFirst": "520111224", "$oidSecond": "1031483086" }`

Responses

Response Schema: application/json

time	integer <int64> データ記録時間
pcode	integer プロジェクトコード
pname	string プロジェクト名
okind	integer 種類別エージェントグループ固有識別子(ID)
onode	integer サーバー別のエージェントグループの固有識別子(ID)
oname	string エージェント名
okindName	string 種類別エージェントグループ名
onodeName	string サーバー別エージェントグループ名
host_ip	string ホストIPアドレス
container	string コンテナ識別子
pid	integer プロセスID
type	string プラットフォームの種類
containerKey	integer コンテナキー
tx_count	integer トランザクション数
tx_error	integer エラーが発生したトランザクション数
tx_time	number <double> トランザクション処理時間
apdex_satisfied	integer Apdex - 満足S
apdex_tolerated	integer Apdex - 許容T
apdex_total	integer Apdex
tx_dbc_time	number <double> データベースコネクションにかかった時間
tx_sql_time	number <double> SQL処理時間
tx_httpc_time	number <double> HTTPクライアント処理時間
sql_count	integer SQLクエリ数
sql_error	integer エラーが発生したSQLクエリ数
sql_time	number <double> SQL処理時間
sql_fetch_count	integer SQLパッチ回数
sql_fetch_time	number <double> SQLフェッチ時間
httpc_count	integer HTTPクライアントリクエスト数
httpc_error	integer エラーが発生したHTTPクライアントリクエスト数
httpc_time	number <double> HTTPクライアント処理時間
active_tx_count	integer アクティブトランザクション数
active_tx_0	integer 3秒未満のアクティブトランザクション
active_tx_3	integer 3秒以上のアクティブトランザクション
active_tx_8	integer 8秒以上のアクティブトランザクション
tps	number <double> 一秒あたりのトランザクション処理数
resp_time	integer レスポンス時間
arrival_rate	number <double> 毎秒到着率
pack_dropped	integer ドロップされたパケット数
metering	integer メータリング
_clock_delta_	integer 時計の差異
oid	integer エージェント固有識別子(ID)

Request samples

Payload
curl

Content type

application/json

{"stime": 1639016640000,
"etime": 1639016940000,
"mql": "CATEGORY app_counter\nOID [ $oidFirst, $oidSecond ]\nTAGLOAD\nSELECT\nINJECT sortByOidDesc",
"limit": 2,
"pageKey": "mxql",
"inject": {"sortByOidDesc": "ORDER {key : [oid],  sort :[desc]}"
},
"param": {"$oidFirst": "1499132250",
"$oidSecond": "1670734023"
}
}

Response samples

200

Content type

application/json

Example

参照されたデータがある場合

[{"time": 1639016640000,
"pcode": 101,
"pname": "Virtual",
"okind": -1085056726,
"onode": 334634079,
"oname": "22136-8075",
"okindName": "ote-virtual-1",
"onodeName": "node-1",
"host_ip": "192.168.1.57",
"container": "ote-8075.service",
"pid": 22206,
"type": "java",
"containerKey": 1876424218,
"tx_count": 58,
"tx_error": 0,
"tx_time": 1643.9138,
"apdex_satisfied": 41,
"apdex_tolerated": 16,
"apdex_total": 58,
"tx_dbc_time": 13.655172,
"tx_sql_time": 222.15517,
"tx_httpc_time": 717.4138,
"sql_count": 129,
"sql_error": 0,
"sql_time": 101.387596,
"sql_fetch_count": 37621,
"sql_fetch_time": 0.00045187527,
"httpc_count": 41,
"httpc_error": 0,
"httpc_time": 1073.4878,
"active_tx_count": 20,
"active_tx_0": 19,
"active_tx_3": 1,
"active_tx_8": 0,
"tps": 13.833333,
"resp_time": 1628,
"arrival_rate": 12.6,
"pack_dropped": 110,
"metering": 4,
"_clock_delta_": 180,
"oid": 1670734023
}
]

MXQL path API

header Parameters

x-whatap-token required	string プロジェクトAPIトークン {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string プロジェクトコード {{projectCode}}

Request Body schema: application/json
required

stime required	integer <int64> 照会開始時間(UNIX epoch time、millisecond)
etime required	integer <int64> 照会終了時間(UNIX epoch time、millisecond)
mql required	string 作成したMXQLクエリ
limit required	integer 最大データ参照数
pageKey required	string 文字列 `mxql`の固定値
	object 次の文書参照例）`{ "default": "ORDER {key : [oid], sort : [desc] }"}`
	object 次の文書参照例）`{ "$oidFirst": "520111224", "$oidSecond": "1031483086" }`

Responses

Response Schema: application/json

pcode	integer プロジェクトコード
pname	string プロジェクト名
oid	integer エージェント固有識別子(ID)
oname	string エージェント名
otype	string エージェントタイプ
okind	integer 種類別エージェントグループ固有識別子(ID)
okindName	string 種類別エージェントグループ名
onode	integer サーバー別のエージェントグループの固有識別子(ID)
onodeName	string サーバー別エージェントグループ名
type	string 製品の種類
subtype	string プラットフォームの種類
version	string バージョン情報
os_name	string オペレーティングシステム名
ip	string IPアドレス
container_id	integer コンテナID
metering	integer メータリング
status	string 状態情報
normal	integer 正常に処理されたトランザクション数
slow	integer 遅いトランザクション数
verySlow	integer 非常に遅いトランザクション数
total	integer 合計トランザクション数
_pk_	string inject

Request samples

Payload

Content type

application/json

{"stime": 1639016640000,
"etime": 1639016940000,
"mql": "/app/act_tx/agent_with_tx",
"limit": 2,
"pageKey": "mxql",
"inject": {"default": "CREATE {key : _pk_, value : okindName}"
},
"param": { }
}

Response samples

200

Content type

application/json

Example

参照されたデータがある場合

[{"pcode": 101,
"pname": "Virtual",
"oid": -1348176005,
"oname": "22137-8071",
"otype": "ap",
"okind": -1085056726,
"okindName": "ote-virtual-1",
"onode": 334634079,
"onodeName": "node-1",
"type": "ap",
"subtype": "java",
"version": "2.1.0 20211207u",
"os_name": "Linux",
"ip": "192.168.1.57",
"container_id": 842770198,
"metering": 4,
"status": "ok",
"normal": 12,
"slow": 1,
"verySlow": 0,
"total": 13,
"_pk_": "okindName"
},
{"pcode": 101,
"pname": "Virtual",
"oid": -883058050,
"oname": "22141-8070",
"otype": "ap",
"okind": -933992004,
"okindName": "ote-virtual-0",
"onode": 1693789385,
"onodeName": "node-0",
"type": "ap",
"subtype": "java",
"version": "2.1.0 20211207u",
"os_name": "Linux",
"ip": "192.168.1.57",
"container_id": 624997205,
"metering": 4,
"status": "ok",
"normal": 19,
"slow": 1,
"verySlow": 0,
"total": 20,
"_pk_": "okindName"
}
]

WhaTap Open API

Open API

Open API Token確認

アカウントトークン確認

プロジェクトトークン確認

プロジェク

プロジェクトリストの照会

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

プロジェクト情報照会

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

プロジェクトメンバー一覧を参照

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

グループ

グループ一覧の表示

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

グループメンバーのリストを表示

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

グループに含まれるプロジェクトを表示

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

エージェント

エージェント状態とホストIP照会

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

oid一覧呼び出し

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

APM Spot情報照会

すべての情報照会

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

アクティブ状態のエージェント数の照会

header Parameters

Responses

Response Schema: text/plain

Request samples

Response samples

非アクティブ状態のエージェント数の照会

header Parameters

Responses

Response Schema: text/plain

Request samples

Response samples

ホスト(HOST) 数

Request Body schema: application/json
required