2.28.2 Collecting, into a CSV file, the performance values in a time series of specified performance information
This request collects, into a CSV file, the performance values in a time series of specified performance information.
Execution permission
Admin, Modify
API version
v1
Request format
POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV/invoke
Request body
The structure of the request 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.) |
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. |
403 |
Forbidden |
No execute privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] POST /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/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: 325 [Request Body] { "name" : "getGraphDataCSV", "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "perfComponentIDs" : [15,16,17], "baseTime" : "2019-09-12T12:10:45.435+09:00", "pointTimeRange" : 36000 } ] } [Response Header] HTTP/1.1 200 OK Date: Thu, 12 Sep 2019 04:59:06 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO e3a9c17a51e3395f81fc1c431d87e295d3cf0f3_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" : "0af73a36-cb9b-4f07-b2c7-4899c9c0be6f", "created" : "2019-09-12T13:59:06.990+09:00", "updated" : "2019-09-12T13:59:07.253+09:00", "completed" : "2019-09-12T13:59:07.253+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ { "data" : "#JP1/Operations Analytics,111000,UTF-8 (BOM)\n#Time Series Performance Information\n#2019-09-12T13:59:07.252+0900\n#R.............." } ] }