Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.28.3 Collecting the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds

This request collects the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "basePointNodes":[{
                "nodeID":"...",
                "nodeType":"..."
            },
            :
            ],
            "baseTime":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetNodesGraphDataCSVParam[]

A list of GetNodesGraphDataCSVParam objects necessary to execute an operation. For details about GetNodesGraphDataCSVParam, see the table below.

parameters (Type: GetNodesGraphDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

List of nodes to be collected, specified as a base point

baseTime

dateTime

Time of the base point when the performance information is collected. If omitted, the time when the API was executed is used as the base point.

basePointNodes (Type: E2ENodeKey)

Attribute

Type

Description

nodeID

long

ID for identifying node

nodeType

enum

Type of the node

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

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 /Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6949777afd26a03da4e0c5e0e02bdb294239992e_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]
{
  "name" : "getNodesGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "selectedNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "baseTime" : "2019-09-12T12:10:47.078+09:00"
  } ]
}