Getting performance information for metrics

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain performance graph information such as performance data and thresholds.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/PerformanceData/actions/getPerformanceData/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 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.)

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

Response body

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

Job

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

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of Collections objects. For details, see the table below.

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	Collections resource list containing the following E2EPerformanceGraphData resources that have the following structure: { "<componentID>":{ "<metricType>": E2EPerformanceGraphData } }
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

Attribute

Type

Description

data

anyType[]

Collections resource list containing the following E2EPerformanceGraphData resources that have the following structure:

{

"<componentID>":{

"<metricType>": E2EPerformanceGraphData

}

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

E2EPerformanceGraphData

{
        "metricType":"...",
        "metricName":"...",
        "thresholdProfileName":"...",
        "thresholdValueOfWarning":"...",
        "thresholdValueOfCritical":"...",
        "proportion":"...",
        "plans":[{
            "instanceID":"...",
            "planType":"...",
            "planName":"...",
            "schedule":["...", ...],
            "from":"...",
            "to":"...",
            "priority":"...",
            "description":"...",
            "thresholdValues":[{
                "instanceID":"...",
                "monitoringMode":"...",
                "metricType":"...",
                "metricTypeName":"...",
                "unit":"...",
                "proportion":"...",
                "thresholdValueOfWarning":"...",
                "thresholdValueOfCritical":"...",
                "stepSize":"...",
                "max":"...",
                "min":"...",
                "maxValueOfDynamic":"...",
                "minValueOfDynamic":"...",
                "avgValueOfDynamic":"..."
            },
            :
            ],
            "monitoringMode":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfCritical":"...",
            "fixed":"..."
        },
        :
        ],
        "minValue":"...",
        "maxValue":"...",
        "unit":"...",
        "currentTime":"...",
        "pointValues":[{
            "pointValuePeak":"...",
            "pointValueAverage":"...",
            "pointTime":"..."
        },
        :
        ]
}

E2EPerformanceGraphData (Type: E2EPerformanceGraphData)

Attribute	Type	Description
metricType	enum	ID of the metric. (For details about the valid values, see the table MetricType in List of enumerators.)
metricName	string	Name of the metric.
thresholdProfileName	string	Name of the threshold profile used to judge the performance status.
thresholdValueOfWarning	float	Value of the warning threshold.
thresholdValueOfCritical	float	Value of the critical threshold.
proportion	boolean	Threshold setting. If a warning or critical alert is generated when the measurement value goes above the threshold, "true" is set. If a warning or critical alert is generated when the measurement value goes below the threshold, "false" is set.
plans	ThresholdPlan[]	Information about the plans set in the threshold profile. This item is specified only for thresholds of user resources.
minValue	float	Minimum value of the performance information.
maxValue	float	Maximum value of the performance information.
unit	string	Unit of measurement used for performance information.
currentTime	dateTime	Start time specified when obtaining performance information.
pointValues	E2EPerformanceGraphPoint[]	Performance value aggregated at the aggregation interval.

plans (Type: ThresholdPlan)

Attribute	Type	Description
instanceID	string	ID of the plan.
planType	enum	Type of the plan. (For details about the valid values, see the table PlanType in List of enumerators.) Base Schedule
planName	string	Name of the plan.
schedule	integer[]	Day of the week when to apply the plan. 1: Mon., 2: Tue., 3: Wed., 4: Thu., 5: Fri., 6: Sat., and 7: Sun. The value set here takes effect only if the plan type is "Schedule".
from	string	Start time of the plan. Specified in "hh:mm" format. The value set here takes effect only if the plan type is "Schedule".
to	string	End time of the plan. Specified in "hh:mm" format. The value set here takes effect only if the plan type is "Schedule".
priority	int	Priority of the plan.
description	string	Description of the plan.
thresholdValues	ThresholdPlanValue[]	Information about the thresholds specified in the plan.
monitoringMode	enum	Monitoring status of the plan. This item is specified when the thresholds are recalculated for each component. (For details about the valid values, see the table MonitoringMode in List of enumerators.)
thresholdValueOfWarning	float	Value of the warning threshold. This item is specified when the thresholds are recalculated for each component.
thresholdValueOfCritical	float	Value of the critical threshold. This item is specified when the thresholds are recalculated for each component.
fixed	boolean	Specifies whether or not to recalculate the thresholds periodically. If the thresholds are recalculated periodically, "true" is set. If the thresholds are not recalculated periodically, "false" is set. This item is specified if the thresholds are to be recalculated for each component.

thresholdValues (Type: ThresholdPlanValue)

Attribute	Type	Description
instanceID	string	ID of the thresholds for each plan.
monitoringMode	enum	Specifies whether or not to enable threshold-based monitoring. If enabled, "true" is set. If disabled, "false" is set. (For details about the valid values, see the table MonitoringMode in List of enumerators.)
metricType	enum	ID of the metric set for a threshold. (For details about the valid values, see the table MetricType in List of enumerators.)
metricTypeName	string	Name of the metric set for a threshold.
unit	string	Unit of the metric set for a threshold.
proportion	boolean	Threshold setting. If a warning or critical alert is generated when the measurement value goes above the threshold, "true" is set. If a warning or critical alert is generated when the measurement value goes below the threshold, "false" is set.
thresholdValueOfWarning	float	Value of the warning threshold.
thresholdValueOfCritical	float	Value of the critical threshold.
stepSize	float	Increment of the threshold.
max	float	Maximum value of the threshold.
min	float	Minimum value of the threshold.
maxValueOfDynamic	float	Maximum value of the dynamic threshold.
minValueOfDynamic	float	Minimum value of the dynamic threshold.
avgValueOfDynamic	float	Average value of a dynamic threshold.

pointValues (Type: E2EPerformanceGraphPoint)

Attribute	Type	Description
pointValuePeak	float	Peak performance value.
pointValueAverage	float	Average performance value.
pointTime	dateTime	Time when the performance information was collected.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.
503	Service Unavailable	Analyzer detail view server communication error.

Example code

[Request Header]
POST /Analytics/v1/services/PerformanceData/actions/getPerformanceData/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
    "name": "getPerformanceData",
    "href": "http://localhost:22015/Analytics/v1/services/PerformanceData/actions/getPerformanceData/invoke",
    "method": "POST",
    "type": "application/json",
    "parameters": [
        {
            "pointTimeRange": 3600000,
            "baseTime": "2016-08-22T14:03:55.971+09:00",
            "perfComponents": [
                {
                    "instanceID": "vm#ITPDLab_172.17.17.115_vm-247",
                    "nodeType": "VIRTUAL_MACHINE",
                    "metricType": "ESX_VM_VM_CPUREADY"
                }
            ],
            "timespan": 1
        }
    ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 05:03:56 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 94e91ec387da8fb0c24e41fbaed4106e50b4121_Y2UOI2pkMXQ=_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": "d326a9b0-cd1f-46d6-9e44-b39eda3f0c42",
    "created": "2016-08-22T14:03:59.710+09:00",
    "updated": "2016-08-22T14:03:59.710+09:00",
    "completed": "2016-08-22T14:03:59.710+09:00",
    "state": "success",
    "affectedResource": [
        
    ],
    "result": [
        {
            "data": {
                "vm#ITPDLab_172.17.17.115_vm-247": {
                    "ESX_VM_VM_CPUREADY": {
                        "instanceID": "vm#ITPDLab_172.17.17.115_vm-247#ESX_VM_VM_CPUREADY",
                        "metricType": "ESX_VM_VM_CPUREADY",
                        "metricName": "CPU Ready (VMware Virtual Machine)",
                        "thresholdProfileName": "Default Profile for VM (VMware)",
                        "proportion": false,
                        "plans": [
                            {
                                "instanceID": "thPlan#ESX_VM",
                                "planType": "Base",
                                "planName": "Base",
                                "schedule": [
                                    1,
                                    2,
                                    3,
                                    4,
                                    5,
                                    6,
                                    7
                                ],
                                "from": "00:00",
                                "to": "24:00",
                                "priority": 1,
                                "description": "Base Plan",
                                "monitoringMode": "Dynamic",
                                "fixed": false
                            }
                        ],
                        "minValue": 0.0,
                        "maxValue": 1.0,
                        "unit": "msec",
                        "currentTime": "2016-08-22T14:03:55.971+09:00",
                        "pointValues": [
                            
                        ]
                    }
                }
            }
        }
    ]
}