2.7.1　アプリケーションの一覧の取得

アプリケーションの一覧を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Applications

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性	データ型	説明
data	anyType[]	Application のコレクション。 Application の詳細は以下の表を参照ください。
pagination	Pagination	ページ情報。リソースが存在しない場合、このパラメータは表示されません。
count	int	条件に合致したデータの個数

pagination (Type: Pagination)

属性	データ型	説明
page	integer	ページ
pageSize	integer	ページサイズ
numPages	integer	ページの数
totalCount	integer	オブジェクトの数

Application

{
        "instanceID":"...",
        "name":"...",
        "applicationType":"...",
        "applicationDetailType":"...",
        "ipAddress":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "applicationHosts":[{
            "resourceID":"...",
            "resourceType":"..."
        },
        :
        ],
        "autoCollectionType":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

Application (Type: Application)

属性	データ型	説明
instanceID	long	インスタンスを特定するID
name	string	発見されたリソース名
applicationType	enum	アプリケーションの種別 (指定可能な値は「列挙型一覧」のApplicationTypeの表を参照してください。) 以下に示す値のみ指定可能です。 AJS_MANAGER AJS_AGENT PFM_SERVICERESPONSE PFM_AJS3 PFM_DOMINO PFM_EXCHANGE PFM_SAPSYSTEM PFM_IBMWEBSPHEREMQ PFM_OPENTP1 PFM_COSMINEXUS PFM_IIS PFM_WEBLOGICSERVER PFM_WEBSPHEREAPPLICATIONSERVER PFM_DB2 PFM_HIRDB PFM_SQL PFM_RMSQLSERVER PFM_ORACLE PFM_RMORACLE PFM_RMPLATFORM PFM_UNIX PFM_WINDOWS IM_OS PFM_RMVIRTUALMACHINE PFM_VIRTUALMACHINE
applicationDetailType	string	任意のアプリケーションの種別
ipAddress	string	アプリケーションのIPアドレス
description	string	アプリケーションの詳細情報
collectorID	long	発見に使用されたコレクターを特定するID
collectorName	string	発見に使用されたコレクターの名称
applicationHosts	ApplicationHost[]	アプリケーションが属するリソースの情報
autoCollectionType	enum	コレクターの定期実行設定 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)
groupIDs	long[]	アプリケーションが割り当たっているコンシューマーを特定するID
groupNames	string[]	アプリケーションが割り当たっているコンシューマーの名称
gradeNames	string[]	アプリケーションが割り当たっているコンシューマーのグレード
gradeOrders	integer[]	アプリケーションが割り当たっているコンシューマーのグレードの優先度
usedCredentialID	long	発見時に使用された認証情報を特定するID
usedCredentials	string	発見時に使用された認証情報
accessPointType	enum	認証情報の種別 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)
accessPointIpAddress	string	認証情報のIPアドレスまたはホスト名
accessPointUser	string	監視対象または管理ソフトウェアへの接続に使用したユーザーID

applicationHosts (Type: ApplicationHost)

属性	データ型	説明
resourceID	long	アプリケーションが属するリソースのID
resourceType	enum	アプリケーションが属するリソースの種別 (指定可能な値は「列挙型一覧」のApplicationResourceTypeの表を参照してください。)

属性

データ型

説明

resourceID

long

アプリケーションが属するリソースのID

resourceType

enum

アプリケーションが属するリソースの種別

(指定可能な値は「列挙型一覧」のApplicationResourceTypeの表を参照してください。)

ステータスコード

HTTPステータスコード	Reason phrase	説明
200	OK	正常終了
401	Unauthorized	ログイン権限がない
403	Forbidden	参照権限がない
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Applications HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3ffa18cbf3e9f46049c06aaf52a1c5444c5e2c3a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "pagination" : {
    "page" : 1,
    "pageSize" : 1,
    "numPages" : 569,
    "totalCount" : 569
  },
  "data" : [ {
    "instanceID" : 568,
    "name" : "IMM-HOST02",
    "applicationType" : "IM_OS",
    "ipAddress" : "IMM-HOST02",
    "description" : "10.197.73.120",
    "collectorID" : 4,
    "collectorName" : "10.197.73.120",
    "applicationHosts":
    [
        {
            "resourceID": 13,
            "resourceType": "Host"
        }
    ],
    "autoCollectionType": "AutoConnect",
    "groupIDs":
    [
        0
    ],
    "groupNames":
    [
        "#Unassigned Resources"
    ],
    "gradeNames":
    [
        ""
    ],
    "gradeOrders":
    [
        -1
    ],
    "usedCredentialID" : 17,
    "accessPointType" : "IM",
    "accessPointIpAddress" : "10.197.73.120",
    "accessPointUser" : "Administrator"
  },
  {
      "instanceID": 567,
      "name": "Zabbix server1",
      "applicationType": "CUSTOM",
      "applicationDetailType": "App Zabbix Server",
      "ipAddress": "192.168.1.251",
      "description": "XX Monitoring System",
      "collectorID": 3,
      "collectorName": "customCollector",
      "applicationHosts":
      [
      ],
      "autoCollectionType": "AutoConnect",
      "groupIDs":
      [
          0
      ],
      "groupNames":
      [
          "#Unassigned Resources"
      ],
      "gradeNames":
      [
          ""
      ],
      "gradeOrders":
      [
          -1
      ],
      "usedCredentialID": 0,
      "accessPointType": "CUSTOM"
  } ],
  "count" : 2
}

2.7.1 アプリケーションの一覧の取得

2.7.1　アプリケーションの一覧の取得