Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.27.1 Collecting the information required to collect, into a CSV file, information about specified resources or a list of related resources

This request collects the information required to collect, into a CSV file, information about specified resources or a list of related resources.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV

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":"..."
            },
            :
            ],
            "getType":"..."
        },
        :
        ]
}

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

GetNodesDataCSVParam[]

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

parameters (Type: GetNodesDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

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

getType

enum

Type of information to be collected

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

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/E2EView/actions/getNodesDataCSV 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:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7aa7a8d2531cf8d09fda40938996444363164b_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" : "getNodesDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "selectedNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "getType" : "AllInformation"
  } ]
}