The following operation is the initial step to obtain performance graph data for a specific metric.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/objects/PerfComponents/{id}/actions/getGraphData
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of E2EGetGraphDataParam objects necessary to execute an operation. For details, see the table below. |
E2EGetGraphDataParam
{
"pointTimeRange":"...",
"baseTime":"...",
"conflict":"...",
"perfComponents":[{
"instanceID":"...",
"nodeType":"...",
"metricType":"..."
},
:
],
"timespan":"...",
"cullTimespan":"..."
}
E2EGetGraphDataParam (Type: E2EGetGraphDataParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
pointTimeRange |
long |
Period during which performance information is obtained (ms). |
|
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. |
|
conflict |
string |
Specifies the type of performance information to be obtained. As the type, "average" or "peak" can be specified. The average value is the average of performance information collected at the interval specified by timespan. The peak value is the most abnormal value in the performance information collected at the interval specified by timespan. If this item is omitted, both the average and peak values are obtained. |
|
perfComponents |
PerformanceDataParam[] |
Information identifying the performance information to be obtained |
|
timespan |
long |
Interval (in minutes) of aggregating performance data. This item is used for calculating the average or worst value in performance information. |
|
cullTimespan |
long |
Interval (in minutes) of cull performance data. |
perfComponents (Type: PerformanceDataParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
instanceID |
string |
ID of the component from which performance information is obtained |
|
nodeType |
enum |
Type of the device that the component, from which performance information is obtained, belongs to (For details about the valid values, see the table E2ENodeType in List of enumerators.) |
|
metricType |
enum |
Type of the metric from which performance information is obtained (For details about the valid values, see the table MetricType 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/objects/PerfComponents/cpu%23ABC_172.17.17.115_host-435%5E0/actions/getGraphData
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:52:07 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]
{
"name" : "getGraphData",
"href" : "http://localhost:22015/Analytics/v1/objects/PerfComponents/cpu%23ABC_172.17.17.115_host%2d435%5E0/actions/getGraphData/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"pointTimeRange" : 3600000,
"baseTime" : "2016-07-20T11:52:07.371+09:00"
} ]
}