Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.27.2 Collecting, into a CSV file, information about specified resources or a list of related resources

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

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

The structure of the request 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.)

Response body

The structure of the response body and the object attributes are as follows:
{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":[{
            "data":"..."
        },
        :
        ]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

CsvData[]

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

result (Type: CsvData)

Attribute

Type

Description

data

string

The CSV data is stored.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

412

Precondition Failed

- The server is not available.

- The threshold of a query parameter was exceeded.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 330

[Request Body]
{
  "name" : "getNodesDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 17512,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "getType" : "AllInformation"
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:27:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4b39fb71c2514aca46ab8275c84e8dbd27788d_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]
{
  "instanceID" : "b201975c-23b5-4d74-b807-09dcb59e11e6",
  "created" : "2019-09-12T13:27:21.864+09:00",
  "updated" : "2019-09-12T13:27:23.330+09:00",
  "completed" : "2019-09-12T13:27:23.330+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,121000,UTF-8 (BOM)\n#Resource Information\n#2019-09-12T13:27:22.389+0900\n............"
  } ]
}