Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Getting a list of resources

You can obtain a list of resources (hypervisors, storage systems, switches, and hosts).

Getting a list of resources

You can obtain a list of resources and resource-related information, such as information about hypervisors, storages, switches, and hosts.

Execution permission

Admin, Modify

Request line
GET baseURL/v1/objects/DiscoveredResources?page={page}&pageSize={size}
Query parameters

The following table describes the values for the supported parameters of a query string:

Parameter

Description

page={page}

(Optional) Specify the paging information (page to be obtained).

Filtering conditions:

Checks whether the comparison target is equal to the value

pageSize={size}

(Optional) Specify the number of items that can be displayed on 1 page.

Filtering conditions:

Checks whether the comparison target is equal to the value

Request body

Not applicable.

Response bodyThe structure of the response body and the object attributes is as follows:

Collections

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

Collections (Type: Collections)

Attribute

Type

Description

data

anyType[]

A list of DiscoveredResource objects. For details about DiscoveredResource, 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 related to this query(API).

pagination (Type: Pagination)

Attribute

Type

Description

page

integer

Page.

pageSize

integer

Size of page.

numPages

integer

Number of pages.

totalCount

integer

Number of objects.

DiscoveredResource

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "clusterName":"...",
        "vmName":"...",
        "modelID":"...",
        "modelName":"...",
        "wwn":"...",
        "resourceType":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "profileResourceType":"...",
        "ipAddressIDs":["...", ...],
        "ipAddresses":["...", ...],
        "componentCriticalCount":"...",
        "componentWarningCount":"...",
        "componentTotalCount":"...",
        "assignmentSchedule":"..."
}

DiscoveredResource (Type: DiscoveredResource)

Attribute

Type

Description

instanceID

string

ID of the device.

name

string

Name of the device.

ipAddress

string

IP address set for the device.

status

enum

Status of the device.

(For details about the valid values, see the table NodeStatusType in List of enumerators.)

  • Normal
  • Warning
  • Critical
  • Unknown

monitorStatus

enum

Monitor status of the device.

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

  • Manage

description

string

Description of the device.

clusterName

string

Cluster name. Specified only if the device is a hypervisor.

vmName

string

Host name of the OS operating on the virtual machine.

modelID

string

ID of the storage system model.

modelName

string

Name of the storage system model.

wwn

string

WWN. Specified only if the device is an FC switch.

resourceType

enum

Type of device.

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

  • SERVER_WINDOWS
  • SERVER_LINUX
  • SERVER_ESX
  • SWITCH_FC
  • STORAGE_HITACHI
  • STORAGE_OTHER
  • SERVER_HYPERV
  • SERVER_VCENTER

thresholdProfileID

string

ID of the threshold profile assigned to the device.

thresholdProfileName

string

Name of the threshold profile assigned to the device.

groupIDs

string[]

ID of the consumer assigned to the device.

groupNames

string[]

Name of the consumer assigned to the device.

gradeNames

string[]

Name of the grade of the consumer assigned to the device.

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the device.

profileResourceType

enum

Resource type of the profile

(For details about the valid values, see the table PerformanceResourceType in List of enumerators.)

ipAddressIDs

string[]

List of the IDs of IP addresses

ipAddresses

string[]

List of the IP addresses.

componentCriticalCount

long

The number of components. (critical)

componentWarningCount

long

The number of components. (warning)

componentTotalCount

long

The number of components. (all)

assignmentSchedule

dateTime

Scheduled assignment time.

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.

503

Service Unavailable

No create privilege.

Example code
[Request Header]
GET /Analytics/v1/objects/DiscoveredResources
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 04:53:24 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1d8dd66aa77a72e2843aef7e599e12dc8a1bbdf3_Y2UOI2pkMXQ=_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": "h#ITPDLab_172.17.17.115_host-158",
            "name": "172.17.17.118",
            "status": "Normal",
            "monitorStatus": "Manage",
            "description": "HITACHI BladeSymphony F51 VMware ESXi N/A",
            "resourceType": "SERVER_ESX",
            "thresholdProfileID": "thProfile#ESX",
            "thresholdProfileName": "Default Profile for Hypervisor (VMware)",
            "groupIDs": [
                
            ],
            "groupNames": [
                
            ],
            "gradeNames": [
                
            ],
            "gradeOrders": [
                
            ],
            "profileResourceType": "ESX",
            "ipAddressIDs": [
                "pn#ITPDLab_172.17.17.115_host-158^vmnic0",
                "pn#ITPDLab_172.17.17.115_host-158^vmnic1"
            ],
            "ipAddresses": [
                
            ],
            "componentCriticalCount": 0,
            "componentWarningCount": 0
        },
        {
        ..........
        },
        ..........
    ],
    "count": 5
}