2.16.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

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:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

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	anyType[]	A list of GetNodesDataCSVParam objects necessary to execute an operation. For details about GetNodesDataCSVParam, see the table below.

GetNodesDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "getType":"..."
}

GetNodesDataCSVParam (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.)

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.)

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:

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

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	anyType[]	A list of CsvData objects. For details about CsvData, see the table below.

CsvData

{
        "data":"..."
}

CsvData (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 http://127.0.0.1:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "basePointNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "selectedNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "highlightNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "getType": "AllInformation"
}

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 22 Nov 2016 02:43:37 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_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" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"\n"#Resource Information"\n..."
  } ]
}