本文へスキップ

メタ情報照会

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

GET https://api.whatap.io/open/api/json/projects

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/projects"
response
{
  "data": [ {
        "groupName": "",
        "projectCode": 35,
        "projectName": "APM_TEST2",
        "createTime": "2018-10-19 07:17:03.774",
        "status": "subscribe",
        "productType": "APM",
        "platform": "JAVA",
        "gatewayName": "LOCAL",
        "apiToken": "5**********************R"
    }, {
    }, (...)
  ],
  "accountEmail": "xxx@whatap.io",
  "total": 6
}
Response FieldField Type説明
gourpNamestringプロジェクト上の親グループ名
projectCodenumberプロジェクトコード
projectNamestringプロジェクト名
createTimestringプロジェクト作成日
lastUpdatedTimestringプロジェクト編集日
statusstringプロジェクトステータス
productTypestringアプリケーションサーバーのタイプ
platformstringアプリケーションサーバーのプラットフォーム
gatewayNamestringゲートウェイ名
apiTokenstringPROJECT API TOKEN
accountEmailstringユーザーアカウントのメールアドレス
totalnumberプロジェクト数

プロジェクト情報照会​

GET https://api.whatap.io/open/api/json/project

ノート

この機能は、Application製品群に対応します。

command
$ 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
{
  "platform": "JAVA",
  "createTime": "Tue Sep 18 08:34:27 GMT 2018",
  "gatewayName": "Office-OTE",
  "projectCode": 1**1,
  "status": "Subscribe",
  "lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018", 
  "name": "SEO_APM",
  "productType": "APM"
}
Response FieldField Type説明
platformstringアプリケーションサーバーのプラットフォーム
createTimestringプロジェクト作成日
projectCodenumberプロジェクトコード
statusstringプロジェクトステータス
lastUpdatedTimestringプロジェクト編集日
productTypestringアプリケーションサーバーのタイプ

プロジェクト情報および詳細サーバー検索​

GET https://api.whatap.io/open/api/json/projects

ノート

この機能は、サーバーモニタリング製品群に該当します。

command
$ 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
{
  "pname":"LOCAL_PC",
  "timezone":9,
  "regionName":"LOCAL",
  "values":{
    "servers":[
      {
        "public_ip":"192.168.1.0",
        "os_cpuvendor":"Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz",
        "agent_created":"1572406071216",
        "ip":"192.168.1.0",
        "os_arch":"amd64",
        "actTime":1572406264112,
        "cpu_cores":"8",
        "oid":-1030311093,
        "isActive":true,
        "okind":"",
        "version":"1.2.4",
        "tags":[
          "network:169.254.0.0/16",
          "network:192.168.1.0/24",
          "java",
          "OpenVpn",
          "oracle",
          "ftp"
        ],
        "inactTime":0,
        "oname":"DESKTOP-KEIPLT5",
        "os_name":"windows",
        "startTime":1572406263602,
        "os_memory":"17036419072",
        "os_status":"warning"
      },
      (...)
    ],
  }
}

プロジェクトエージェントのステータスおよびホスト照会​

GET https://api.whatap.io/open/json/agents

command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/json/agents"
response
{
   "data":[
      {
         "host_ip":"127.0.0.1",
         "oname":"TC-29-96-8082",
         "active":true
      }, { 
      } (...)
   ]
}

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

GET https://api.whatap.io/open/api/json/project/projectCode/members

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/project/{{projectCode}}/members"
response
{
  "data": [ {
      "email": "honggildong@whatap.io",
      "name": "홍길동",
      "typeKey": "super_admin",
      "typeName": "Super Admin"
    }, {
    }, (...)
      ],
  "total": 6
}
Response FieldField Type説明
emailstringユーザーアカウントのメールアドレス
namestringユーザーアカウント名
typeKeystringユーザー権限
typeNamestringユーザー権限の指定
totalnumberプロジェクトメンバー数

グループ一覧の表示​

GET https://api.whatap.io/open/api/json/groups

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/v2/json/groups"
response
{
  "data": [ {
        "groupName": "WHATAP APM",
        "groupKey": "
grp****ab123kskd*****q",
        "description": "APM Group"
    }, {
    }, (...)
  ],
  "total": 3
}

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

GET https://api.whatap.io/open/api/json/group/groupKey/members

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/members"
response
{
  "data": [ {
      "groupName": "WHATAP APM",
      "groupKey": "AB123KSKD*****2uasQ",
      "description": "APM Group"
    }, {
    }, (...)
  ],
  "total": 3
}

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

GET https://api.whatap.io/open/api/json/group/groupKey/projects

グループに含まれるプロジェクトのメタ情報を参照するAPIです。アカウントのAPI Tokenが必要であり、curlを使用した例のリクエストの例を以下を参照してください。

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/projects"
response
{
  "data": [
    {
      "projectCode":35,
      "name":"APM_TEST2",
      "status":"Subscribe",
      "productType":"APM",
      "platform":"JAVA",
      "gatewayName":"LOCAL"
    }, {
    }, (...)
  ]
}
Response FieldField Type説明
projectCodenumber(integer)プロジェクトコード
namestringプロジェクト名
statusstringプロジェクトステータス (pending, trial, subscribe, close_pending, limited, closed, trial_limited)
productTypestringプロジェクトに使用された製品
platformstringプロジェクトに使用された製品のプラットフォーム
gatewayNamestringデータサーバーリージョン

oid一覧呼び出し​

ユーザーが表示したい時間帯を有効になっているエージェント情報を確認できます。

POST https://api.whatap.io/open/api/v2/agent/list

request
curl --location 'https://api.whatap.io/open/api/v2/agent/list' -H 'x-whatap-token: {{PROJECT API TOKEN}}
' -H 'x-whatap-pcode: {{projectCode}}' -d '{"stime":1690850183000,"etime":1693321200000}'
response
{
    "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
        },
      ...
    ]
}
ノート

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

    • 1693475430087 (unix timestamp)
    • yyyyMMddHHmmss
    • yyyyMMddHHmm
    • MMddHHmmss
    • MMddHHmm

  • 参照時間(stime, etime)は一日に制限され、ms(millisecond)単位です。