Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.11.1 Obtaining Application List

The API acquires a list of applications.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "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)

Attribute

Type

Description

data

Application[]

A list of Application objects. For details about Application, see the table below.

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions.

data (Type: Application)

Attribute

Type

Description

instanceID

long

Instance ID

name

string

Name of the detected application

applicationType

enum

Application type

(For details about the specifiable values, see the table ApplicationType in List of enumerators.)

The specifiable values are as follows:

  • 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

Type of the custom application

ipAddress

string

IP address of the application

description

string

Detailed information about the application

collectorID

long

ID identifying the collector used for detection

collectorName

string

Name of the collector used for detection

applicationHosts

ApplicationHost[]

Resources to which the application belongs

applicationContainers

ApplicationContainer[]

Containers to which the application belongs

autoCollectionType

enum

Settings for periodic execution of the collector

(For details about the specifiable values, see the table ConnectType in List of enumerators.)

groupIDs

long[]

ID identifying the consumer to which the application is allocated

groupNames

string[]

Name of the consumer to which the application is allocated

gradeNames

string[]

Grade of the consumer to which the application is allocated

gradeOrders

integer[]

Priority of the grade of the consumer to which the application is allocated

usedCredentialID

long

ID identifying the authentication information used at detection

accessPointType

enum

Type of collector used at detection

(For details about the specifiable values, see the table ProtocolType in List of enumerators.)

accessPointIpAddress

string

IP address or host name of the authentication information

accessPointUser

string

User ID used to connect to monitoring targets or management software

applicationHosts (Type: ApplicationHost)

Attribute

Type

Description

resourceID

long

ID of the resource to which the application belongs

resourceType

enum

Type of the resource to which the application belongs

(For details about the specifiable values, see the table ApplicationResourceType in List of enumerators.)

The specifiable values are as follows:

  • VirtualMachine
  • Host
  • ServiceInstance

applicationContainers (Type: ApplicationContainer)

Attribute

Type

Description

resourceID

long

ID of the resource to which the application belongs

resourceType

enum

Type of the resource to which the application belongs

(For details about the specifiable values, see the table ApplicationResourceType in List of enumerators.)

The specifiable values are as follows:

  • Pod

pagination (Type: Pagination)

Attribute

Type

Description

page

integer

page

pageSize

integer

Size of the pages

numPages

integer

Number of the pages

totalCount

integer

Number of the objects

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[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
}