MXQL Open API

Open APIを使用してMXQLデータを表示する方法について説明します。

ノート

MXQLについての詳細は次の文書を参照してください。

MXQL Open APIの種類

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

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

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

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

MXQLOpenAPIを呼び出す

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

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

注意

MXQL Open APIの制限事項

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

MXQL text API

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

MXQL実行結果の例

POST https://api.whatap.io/open/api/flush/mxql/text

Request
curl --location 'https://api.whatap.io/open/api/flush/mxql/text' \
-H 'x-whatap-token: {{PROJECT API TOKEN}}' \
-H 'x-whatap-pcode: {{projectCode}}' \
-H 'Content-Type: application/json' \
-d '{
  "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"
  }
}'

Key	Value
stime	データ参照の開始時間
etime	データ参照の終了時間
mql	作成したMXQLクエリ
limit	最大データ照会数
pageKey	文字列 `mxql`の固定値
inject	Optional 次の文書参照例）`{ "default": "ORDER {key : [oid], sort : [desc] }"}`
param	Optional 次の文書参照例）`{ "$oidFirst": "520111224", "$oidSecond": "1031483086" }`

ノート

リクエストの本文にstime、etime、$oidFirst、$oidSecond項目は、ユーザー環境に適した時間、oid値で適用する必要があります。

照会されたデータがない場合
ResponseBody Example 1
```
[]
```

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

ResponseBody Example 2
[
  {
    "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": 4.5187527E-4,
    "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
  },
  {
    "time": 1639016640000,
    "pcode": 101,
    "pname": "Virtual",
    "okind": -933992004,
    "onode": 1693789385,
    "oname": "22134-8074",
    "okindName": "ote-virtual-0",
    "onodeName": "node-0",
    "host_ip": "192.168.1.57",
    "container": "ote-8074.service",
    "pid": 22202,
    "type": "java",
    "containerKey": 2024596057,
    "tx_count": 56,
    "tx_error": 0,
    "tx_time": 1545.4464,
    "apdex_satisfied": 37,
    "apdex_tolerated": 18,
    "apdex_total": 56,
    "tx_dbc_time": 13.375,
    "tx_sql_time": 209.01785,
    "tx_httpc_time": 661.3214,
    "sql_count": 125,
    "sql_error": 0,
    "sql_time": 77.808,
    "sql_fetch_count": 41112,
    "sql_fetch_time": 3.162094E-4,
    "httpc_count": 39,
    "httpc_error": 0,
    "httpc_time": 1138.1538,
    "active_tx_count": 18,
    "active_tx_0": 14,
    "active_tx_3": 4,
    "active_tx_8": 0,
    "tps": 10,
    "resp_time": 2924,
    "arrival_rate": 10.8,
    "pack_dropped": 35,
    "metering": 4,
    "_clock_delta_": 128,
    "oid": 1499132250
  }
]

MXQL path API

POST https://api.whatap.io/open/api/flush/mxql/path

Request
# INJECTで_pk_カラムを追加、paramは使用しない
curl --location 'https://api.whatap.io/open/api/flush/mxql/path' \
-H 'x-whatap-token: {{PROJECT API TOKEN}}' \
-H 'x-whatap-pcode: {{projectCode}}' \
-H 'Content-Type: application/json' \
-d '{
  "stime": 1639016640000,
  "etime": 1639016940000,
  "mql": "/app/act_tx/agent_with_tx",
  "limit": 2,
  "pageKey": "mxql",
  "inject": {
    "default": "CREATE {key : _pk_, value : okindName}"
  },
  "param": {
  }
}'

Key	Value
stime	データ参照の開始時間
etime	データ参照の終了時間
mql	次の文書を参照
limit	最大データ参照数
pageKey	文字列 `mxql`の固定値
inject	Optional 次の文書参照例）`{ "default": "ORDER {key : [oid], sort : [desc] }" }`

ノート

リクエストの本文にstime、etime項目は、ユーザー環境に適した時間で適用する必要があります。

照会されたデータがない場合
ResponseBody Example 1
```
[]
```

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

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

MXQL Open APIの種類​

MXQLOpenAPIを呼び出す​

MXQL text API​

MXQL path API​

MXQL Open APIの種類

MXQLOpenAPIを呼び出す

MXQL text API

MXQL path API