2.28.1 Collecting the information required to collect, into a CSV file, the performance values in a time series of specified performance information

This request collects the information required to collect, into a CSV file, the performance values in a time series of specified performance information.

Execution permission

Admin, Modify

API version

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

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

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

parameters (Type: GetGraphDataCSVParam)

Attribute	Type	Description
perfComponentIDs	long[]	ID of perfComponents
baseTime	dateTime	Start time for obtaining performance information. The performance information for a certain period before the specified start time is obtained. The period is specified by pointTimeRange. If this item is omitted, the time that the API was executed is used as the start time.
pointTimeRange	long	Period during which performance information is obtained (ms.)

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/getGraphDataCSV 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:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 60749ea2f05a1ff3a3db16f9af8ac3d45958a1_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" : "getGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "perfComponentIDs" : [ ],
    "baseTime" : "2019-09-12T12:10:45.435+09:00",
    "pointTimeRange" : 3600000
  } ]
}