アプリケーションモデル API

このページでは、アプリケーション API を使用して、AppDynamics でモデル化された監視対象環境に関する情報を取得する方法について説明します。この情報には、モデル化された環境のビジネスアプリケーション、ビジネストランザクション、階層、およびノードの名前や ID などが含まれます。

すべてのビジネスアプリケーションを取得する

アプリケーション API メソッドは、ビジネスアプリケーション名と内部数値識別子を返します。コントローラ API の操作の多くは、ビジネスアプリケーションのコンテキストで行われます。このメソッドを使用して、他のメソッドを呼び出す前に使用するアプリケーション名または ID を検出します。

形式

GET /controller/rest/applications

Input parameters

Parameter Name

Parameter Type

Value

必須

output

[Query（クエリ）]

出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は XML（デフォルト）または JSON です。

なし

time-range-type

時間

時間範囲オプション（time-range-type、startTime、endTime）に基づいてデータをフィルタ処理する時間パラメータ。time-range-type オプションが指定されている場合、クエリは、その GMT 日に動作中のアプリケーションを返します。指定されていない場合、クエリはすべてのアプリケーションを返します。

ケース 1：time-range-type が最後の T 分で、 time-range-type が 1 GMT 日に該当する場合、API はその GMT 日に動作中のすべてのアプリケーションを返します。
ケース 2：time-range-type が最後の T 分で、time-range-type が 2 GMT 日に該当する場合（たとえば、現在の時刻が 4:05 PST で、指定した time-range-type が最後の 10 分である場合、API はこの GMT 日および前の GMT 日に動作中のアプリケーションを返します）。

この機能は SaaS でのみ使用でき、API はオンプレミスのすべてのアプリケーションを返します。

詳細については、「メトリックとスナップショット API」を参照してください。

なし

動作中のアプリケーションとは、指定された時間範囲内に 1 つ以上のメトリックをコントローラに送信するノードを 1 つ以上使用するアプリケーションを指します。

例

curl --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications
 
<applications>
   <application>
     <id>5</id>
     <name>ECommerce_E2E</name>
   </application>
   <application>
     <id>8</id>
     <name>ECommerce_E2E-Fulfillment</name>
   </application>
   <application>
     <id>11</id>
     <name>jimix12110919</name>
     <description/>
     <accountGuid>429c7884-3f36-4b5a-9412-fdf827e6c86e</accountGuid>
   </application>
</applications>

ビジネスアプリケーションのすべてのビジネストランザクションを取得する

形式

GET /controller/rest/applications/application_name/business-transactions

入力パラメータ

Parameter Name	Parameter Type	Value	必須
`application_name`	URI	アプリケーション名またはアプリケーション ID。	あり
`exclude`	[Query（クエリ）]	`false`：クエリは、モニタリングに含まれるビジネストランザクションのみを取得します。 `true`：クエリは、除外されたビジネストランザクションのみを取得します。除外されたビジネストランザクションは、UI から、または REST インターフェイスを使用して、モニタリングから除外されるように設定されています。デフォルトは `false` です。	なし
`output`	[Query（クエリ）]	出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は `XML`（デフォルト）または `JSON` です。	なし
`time-range-type`	時刻	時間範囲オプション（`time-range-type`、`startTime`、`endTime`）に基づいてデータをフィルタ処理する時間パラメータ。`time-range-type` オプションが指定されている場合、クエリは、その GMT 日に動作中のビジネストランザクションを返します。指定されていない場合、クエリはすべてのビジネストランザクションを返します。ケース 1：`time-range-type` が最後の T 分で、`time-range-type` が 1 GMT 日に該当する場合、API はその GMT 日に動作中のすべてのビジネストランザクションを返します。ケース 2：`time-range-type` が最後の T 分で、 `time-range-type` が 2 GMT 日に該当する場合（たとえば、現在の時刻が 4:05 PST で、指定した `time-range-type` が最後の 10 分である場合、API はこの GMT 日および前の GMT 日に動作中のビジネストランザクションを返します）。この機能は SaaS でのみ使用でき、API はオンプレミスのすべてのビジネストランザクションを返します。「メトリックとスナップショット API」を参照してください。	[いいえ（No）]

動作中のビジネストランザクションとは、指定された時間範囲内に 1 つ以上のメトリックをコントローラに送信するトランザクションを指します。

例

curl --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications/5/business-transactions

<business-transactions>
   <business-transaction>
     <id>92</id>
     <name>/user/.POST</name>
     <entryPointType>WEB_SERVICE</entryPointType>
     <internalName>/user/.POST</internalName>
     <tierId>9</tierId>
     <tierName>ECommerce-Services</tierName>
     <background>false</background>
   </business-transaction>
   ...
   <business-transaction>
     <id>184</id>
     <name>OrderServiceImplService.createOrder</name>
     <entryPointType>WEB_SERVICE</entryPointType>
     <internalName>OrderServiceImplService.createOrder</internalName>
     <tierId>12</tierId>
     <tierName>Inventory-Services</tierName>
     <background>false</background>
   </business-transaction>
</business-transactions>

ビジネスアプリケーションのすべての階層を取得する

形式

GET /controller/rest/applications/application_name/tiers

入力パラメータ

Parameter Name

Parameter Type

Value

必須

application_name

URI

アプリケーション名またはアプリケーション ID。

あり

output

[Query（クエリ）]

出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は XML（デフォルト）または JSON です。

なし

time-range-type

時刻

時間範囲オプション（time-range-type、startTime、endTime）に基づいてデータをフィルタ処理する時間パラメータ。 time-range-type オプションが指定されている場合、クエリは、その GMT 日に動作中の階層を返します。指定されていない場合、クエリはすべての階層を返します。

ケース 1：time-range-type が最後の T 分で、 time-range-type が 1 GMT 日に該当する場合、API はその GMT 日に動作中のすべての階層を返します。
ケース 2：time-range-type が最後の T 分で、time-range-type が 2 GMT 日に該当する場合（たとえば、現在の時刻が 4:05 PST で、指定した time-range-type が最後の 10 分である場合、API はこの GMT 日および前の GMT 日に動作中の階層を返します）。

この機能は SaaS でのみ使用でき、API はオンプレミスのすべての階層を返します。

「メトリックとスナップショット API」を参照してください。

[いいえ（No）]

動作中の階層とは、指定された時間範囲内に 1 つ以上のメトリックをコントローラに送信するこの階層内のノードを 1 つ以上使用する階層を指します。

例

curl --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications/5/tiers

<tiers>
<tier>
  <id>8</id>
  <name>Address-Services</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
<tier>
  <id>16</id>
  <name>Customer-Survey-Services</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
<tier>
  <id>9</id>
  <name>ECommerce-Services</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>2</numberOfNodes>
</tier>
<tier>
  <id>12</id>
  <name>Inventory-Services</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
<tier>
  <id>17</id>
  <name>Order-Processing-Services</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
<tier>
  <id>18</id>
  <name>Web-Tier-Services</name>
  <type>Web Server</type>
  <agentType>NATIVE_WEB_SERVER</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
</tiers>

ビジネスアプリケーションの登録済みバックエンドとプロパティをすべて取得する

形式

GET /controller/rest/applications/application_name/backends

入力パラメータ

Parameter Name	Parameter Type	Value	必須
`application_name`	URI	アプリケーション名またはアプリケーション ID のいずれかを指定します。	あり
`output`	[Query（クエリ）]	出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は `XML`（デフォルト）または `JSON` です。	なし

例

curl --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications/5/backends

<backends><backend>
  <id>10</id>
  <name>INVENTORY-MySQL DB-DB</name>
  <exitPointType>JDBC</exitPointType>
  <properties>
    <name-value>
      <id>0</id>
      <name>HOST</name>
      <value>DB</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>MAJOR_VERSION</name>
      <value>5.5.44-0ubuntu0.14.04.1</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>PORT</name>
      <value>3306</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>SCHEMA</name>
      <value>INVENTORY</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>URL</name>
      <value>jdbc:mysql://db:3306/inventory?useUnicode=true&amp;characterEncoding=UTF-8&amp;autoReconnect=true</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>VENDOR</name>
      <value>MySQL DB</value>
    </name-value>
  </properties>
  <applicationComponentNodeId>0</applicationComponentNodeId>
  <tierId>0</tierId>
</backend>
 ...
<backend>
  <id>14</id>
  <name>Active MQ-OrderQueue</name>
  <exitPointType>JMS</exitPointType>
  <properties>
    <name-value>
      <id>0</id>
      <name>DESTINATION_NAME</name>
      <value>OrderQueue</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>DESTINATION_TYPE</name>
      <value>QUEUE</value>
    </name-value>
    <name-value>
      <id>0</id>
      <name>VENDOR</name>
      <value>Active MQ</value>
    </name-value>
  </properties>
  <applicationComponentNodeId>0</applicationComponentNodeId>
  <tierId>0</tierId>
</backend>
</backends>

ビジネスアプリケーションのすべてのノードのノード情報を取得する

形式

GET /controller/rest/applications/application_name/nodes

入力パラメータ

Parameter Name

Parameter Type

Value

必須

application_name

URI

アプリケーション名またはアプリケーション ID のいずれかを指定します。

あり

output

[Query（クエリ）]

出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は XML（デフォルト）または JSON です。

なし

time-range-type

時刻

時間範囲オプション（time-range-type、startTime、endTime）に基づいてデータをフィルタ処理する時間パラメータ。time-range-type オプションが指定されている場合、クエリは、その GMT 日に動作中のノードを返します。指定されていない場合、クエリはすべてのノードを返します。

ケース 1：time-range-type が最後の T 分で、time-range-type が 1 GMT 日に該当する場合、API はその GMT 日に動作中のすべてのノードを返します。
ケース 2：time-range-type が最後の T 分で、time-range-type が 2 GMT 日に該当する場合（たとえば、現在の時刻が 4:05 PST で、指定した time-range-type が最後の 10 分である場合、API はこの GMT 日および前の GMT 日に動作中のノードを返します）。

この機能は SaaS でのみ使用でき、API はオンプレミスのすべてのノードを返します。

「メトリックとスナップショット API」を参照してください。

[いいえ（No）]

動作中のノードとは、指定された時間範囲で少なくとも 1 つのメトリックをコントローラに送信するノードを指します。

例

curl --user user1@customer1:welcome http://demo.appdynamics.com:8090/controller/rest/applications/5/nodes


<nodes><node>
  <id>7</id>
  <name>Node_8000</name>
  <type>Tomcat 5.x</type>
  <tierId>12</tierId>
  <tierName>ECommerce Server</tierName>
  <machineId>3</machineId>
  <machineName>TIER1TOMCAT</machineName>
  <machineOSType>Linux</machineOSType>
  <machineAgentPresent>true</machineAgentPresent>
  <machineAgentVersion>Machine Agent v4.2.0.0 GA Build Date 2015-12-18 18:47:15</machineAgentVersion>
  <appAgentPresent>true</appAgentPresent>
  <appAgentVersion>Server Agent v4.2.0.0 GA #10145 r514d60d3122bd992e7152820d2ca5fb5ff4e45c1 8409-master-build</appAgentVersion>
  <agentType>APP_AGENT</agentType>
</node>
...
<node>
  <id>10</id>
  <name>Node_8002</name>
  <type>Tomcat 5.x</type>
  <tierId>14</tierId>
  <tierName>Inventory Server</tierName>
  <machineId>6</machineId>
  <machineName>TIER3TOMCAT</machineName>
  <machineOSType>Linux</machineOSType>
  <machineAgentPresent>true</machineAgentPresent>
  <machineAgentVersion>Machine Agent v4.2.0.0 GA Build Date 2015-12-18 18:47:15</machineAgentVersion>
  <appAgentPresent>true</appAgentPresent>
  <appAgentVersion>Server Agent v4.2.0.0 GA #10145 r514d60d3122bd992e7152820d2ca5fb5ff4e45c1 8409-master-build</appAgentVersion>
  <agentType>APP_AGENT</agentType>
</node>
</nodes>

ノード情報をノード名ごとに取得する

形式

GET /controller/rest/applications/application_name/nodes/node_name

入力パラメータ

Parameter Name	Parameter Type	Value	必須
`application_name`	URI	アプリケーション名またはアプリケーション ID。	あり
`node_name`	URI	ノード名または ID	あり
`output`	[Query（クエリ）]	出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は `XML`（デフォルト）または `JSON` です。	なし

例

curl --user user1@customer1:welcome http://demo.appdynamics.com:8090/controller/rest/applications/5/nodes/10

<nodes><node>
  <id>10</id>
  <name>Node_8002</name>
  <type>Tomcat 5.x</type>
  <tierId>14</tierId>
  <tierName>Inventory Server</tierName>
  <machineId>6</machineId>
  <machineName>TIER3TOMCAT</machineName>
  <machineOSType>Linux</machineOSType>
  <machineAgentPresent>true</machineAgentPresent>
  <machineAgentVersion>Machine Agent v4.2.0.0 GA Build Date 2015-12-18 18:47:15</machineAgentVersion>
  <appAgentPresent>true</appAgentPresent>
  <appAgentVersion>Server Agent v4.2.0.0 GA #10145 r514d60d3122bd992e7152820d2ca5fb5ff4e45c1 8409-master-build</appAgentVersion>
  <ipAddresses>
    <ipAddress>10.0.32.138</ipAddress>
  </ipAddresses>
  <agentType>APP_AGENT</agentType>
</node>
</nodes>

階層に含まれるすべてのノードのノード情報を取得する

形式

GET /controller/rest/applications/application_name/tiers/tier_name/nodes

入力パラメータ

Parameter Name	Parameter Type	Value	必須
`application_name`	URI	アプリケーション名またはアプリケーション ID。	あり
`tier_name`	URI	階層名または ID。	あり
`output`	[Query（クエリ）]	出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は `XML`（デフォルト）または `JSON` です。	なし
`time-range-type`	時間	時間範囲オプション（time-range-type、`startTime`、`endTime`）に基づいてデータをフィルタ処理する時間パラメータ。time-range-type オプションが指定されている場合、クエリは、その GMT 日に動作中のノードを返します。指定されていない場合、クエリはすべてのノードを返します。ケース 1：`time-range-type` が最後の T 分で、`time-range-type` が 1 GMT 日に該当する場合、API はその GMT 日に動作中のすべてのノードを返します。ケース 2：`time-range-type` が最後の T 分で、`time-range-type` が 2 GMT 日に該当する場合（たとえば、現在の時刻が 4:05 PST で、指定した `time-range-type` が最後の 10 分である場合、API はこの GMT 日および前の GMT 日に動作中のノードを返します）。この機能は SaaS でのみ使用でき、API はオンプレミスのすべてのノードを返します。「メトリックとスナップショット API」を参照してください。	なし

例

curl --user user1@customer1:welcome http://demo.appdynamics.com:8090/controller/rest/applications/25/tiers/70/nodes

<nodes><node>
  <id>81</id>
  <name>PHP_Node</name>
  <type>Other</type>
  <tierId>70</tierId>
  <tierName>PHP_Tier</tierName>
  <machineId>65</machineId>
  <machineName>232fe50b8f9c</machineName>
  <machineOSType>Linux</machineOSType>
  <machineAgentPresent>false</machineAgentPresent>
  <appAgentPresent>true</appAgentPresent>
  <appAgentVersion>Proxy v4.2.0.0 GA SHA-1:.c86ec090f4ff77195df065fe56dade4dfc3913aa #9909 8869-master-build</appAgentVersion>
  <ipAddresses>
    <ipAddress>fe80:0:0:0:42:acff:fe11:2%eth0</ipAddress>
    <ipAddress>172.17.0.2</ipAddress>
  </ipAddresses>
  <agentType>PHP_APP_AGENT</agentType>
</node>
</nodes>

階層情報を階層名ごとに取得する

形式

GET /controller/rest/applications/application_name/tiers/tier_name

入力パラメータ

Parameter Name	Parameter Type	Value	必須
`application_name`	URI	アプリケーション名またはアプリケーション ID。	あり
`tier_name`	URI	階層名または ID。	あり
`output`	[Query（クエリ）]	出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は `XML`（デフォルト）または `JSON` です。	なし

例

curl --user user1@customer1:welcome http://demo.appdynamics.com:8090/controller/rest/applications/5/tiers/14

<tiers><tier>
  <id>14</id>
  <name>Inventory Server</name>
  <type>Application Server</type>
  <agentType>APP_AGENT</agentType>
  <numberOfNodes>1</numberOfNodes>
</tier>
</tiers>