Hitachi

JP1 Version 12 JP1/Operations Analytics REST APIリファレンス


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

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

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

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

リクエストボディー

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

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "applicationType":"...",
            "applicationDetailType":"...",
            "ipAddress":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "applicationHosts":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "applicationContainers":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "autoCollectionType":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "usedCredentialID":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

Application[]

Applicationのコレクション。Applicationの詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

data (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
  • CUSTOM

applicationDetailType

string

任意のアプリケーションの種別

ipAddress

string

アプリケーションのIPアドレス

description

string

アプリケーションの詳細情報

collectorID

long

発見に使用されたコレクターを特定するID

collectorName

string

発見に使用されたコレクターの名称

applicationHosts

ApplicationHost[]

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

applicationContainers

ApplicationContainer[]

アプリケーションが属するコンテナの情報

autoCollectionType

enum

コレクターの定期実行設定

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

groupIDs

long[]

アプリケーションが割り当たっているコンシューマーを特定するID

groupNames

string[]

アプリケーションが割り当たっているコンシューマーの名称

gradeNames

string[]

アプリケーションが割り当たっているコンシューマーのグレード

gradeOrders

integer[]

アプリケーションが割り当たっているコンシューマーのグレードの優先度

usedCredentialID

long

発見時に使用された認証情報を特定するID

accessPointType

enum

認証情報の種別

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

accessPointIpAddress

string

認証情報のIPアドレスまたはホスト名

accessPointUser

string

監視対象または管理ソフトウェアへの接続に使用したユーザーID

applicationHosts (Type: ApplicationHost)

属性

データ型

説明

resourceID

long

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

resourceType

enum

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

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

以下に示す値のみ指定可能です。

  • VirtualMachine
  • Host
  • ServiceInstance

applicationContainers (Type: ApplicationContainer)

属性

データ型

説明

resourceID

long

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

resourceType

enum

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

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

以下に示す値のみ指定可能です。

  • Pod

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

ステータスコード

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
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:56 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO adc7673b35acc7ad6d344d54cb169e2ca2a13_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 220,
    "name" : "HiRDBInstance1",
    "applicationType" : "PFM_HIRDB",
    "ipAddress" : "DBHost-2",
    "description" : "DBHost-2",
    "collectorID" : 150,
    "collectorName" : "PFM_Manager",
    "applicationHosts" : [{
      "resourceID" : 150,
      "resourceType" : "ServiceInstance"
    }],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 200,
    "accessPointType" : "PFM",
    "accessPointIpAddress" : "10.197.64.118",
    "accessPointUser" : "root"
  }, {
    "instanceID" : 53,
    "name" : "Zabbix server",
    "applicationType" : "CUSTOM",
    "applicationDetailType" : "Template App Zabbix Server",
    "ipAddress" : "zabbix",
    "description" : "zabbix",
    "collectorID" : 6,
    "collectorName" : "zabbix",
    "applicationHosts" : [ ],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 18,
    "accessPointType" : "CUSTOM"
  }, {
    "instanceID" : 237,
    "name" : "AJSM-HOST",
    "applicationType" : "AJS_MANAGER",
    "ipAddress" : "AJSM-HOST",
    "description" : "AJSM-HOST : @SYSTEM",
    "collectorID" : 151,
    "collectorName" : "AJS",
    "applicationHosts" : [ {
      "resourceID" : 20,
      "resourceType" : "Host"
    }, {
      "resourceID" : 14261,
      "resourceType" : "VirtualMachine"
    } ],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 201,
    "accessPointType" : "AJS",
    "accessPointIpAddress" : "JP1ALL",
    "accessPointUser" : "administrator"
  }, {
    "instanceID" : 162,
    "name" : "IMM-HOST",
    "applicationType" : "IM_OS",
    "ipAddress" : "IMM-HOST",
    "description" : "IMM-HOST",
    "collectorID" : 101,
    "collectorName" : "IM_Collector",
    "applicationHosts" : [ {
      "resourceID" : 20,
      "resourceType" : "Host"
    }, {
      "resourceID" : 14261,
      "resourceType" : "VirtualMachine"
    } ],
    "applicationContainers" : [ {
      "resourceID" : 3001,
      "resourceType" : "Pod"
    } ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 151,
    "accessPointType" : "IM",
    "accessPointIpAddress" : "10.197.64.116",
    "accessPointUser" : "administrator"
  } ],
  "count" : 4
}