Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.4.6 Obtaining Information about Discovered Resources

This API request acquires information about resources discovered in the last discovery.

Execution permission

Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "data":[{
            "ipAddress":"...",
            "name":"...",
            "nodeName":"...",
            "monitorStatus":"...",
            "deviceType":"...",
            "credentialType":"...",
            "nodeInformationGettableLevel":"...",
            "discoveryLogCategory":"...",
            "autoManage":"...",
            "credentialName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

DiscoveryLogResource[]

A list of DiscoveryLogResource objects. For details about DiscoveryLogResource, 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: DiscoveryLogResource)

Attribute

Type

Description

ipAddress

string

IP address of the resource

name

string

Name of the IP address range used in the discovery

nodeName

string

Resource name

monitorStatus

enum

Management status of the resource

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

The specifiable values are as follows:

  • New
  • Manage
  • ignore
  • MonitorOff

deviceType

enum

Device type of the resource

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

The specifiable values are as follows:

  • SERVER_WINDOWS
  • SERVER_LINUX
  • SERVER_ESX
  • SWITCH_FC
  • SWITCH_IP
  • STORAGE_HITACHI
  • STORAGE_OTHER
  • GENERIC_COMPUTER
  • GENERIC_STORAGE
  • SERVER_SOLARIS
  • SERVER_HYPERV
  • SERVER_HPUX
  • SERVER_AIX
  • GENERIC_HYPERVISOR

credentialType

enum

Type of authentication credentials used in the discovery

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

The specifiable values are as follows:

  • WMI
  • SSH
  • WBEM
  • SNMP

nodeInformationGettableLevel

enum

Result of the authentication credentials used in the discovery. This property is set when discoveryLogCategory is NoResponse or Failed.

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

The specifiable values are as follows:

  • OK
  • ProtocolUnrecognizedError
  • AuthenticationError
  • UnauthorizedRoleError
  • OtherError
  • ClusterIPAddressNotSupported
  • NoResponse
  • UnsupportDeviceError
  • UnexpectedDeviceError
  • TimeoutError
  • RequestTooMuchError

discoveryLogCategory

enum

Category of discovered resources

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

autoManage

boolean

To automatically manage discovered resources, set true.

credentialName

string

Name of the authentication credentials used in the discovery

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/DiscoveryLogResources/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:40:47 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO eed864e1af108faf58e4f486be419a1f45fca74_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 305

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "ipAddress" : "192.168.11.1",
    "name" : "test",
    "nodeName" : "test-server",
    "monitorStatus" : "Manage",
    "deviceType" : "SERVER_WINDOWS",
    "discoveryLogCategory" : "Skipped",
    "credentialName" : "test"
  } ],
  "count" : 1
}