Getting the parameter used to get metrics for the predictive result

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

The following operation performs the initial step to get metrics for a predictive result.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/services/PredictionHistory/actions/getTargets

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 PredictionHistory objects necessary to execute an operation. For details, see the table below.

PredictionHistory

{
        "name":"...",
        "description":"...",
        "reportID":"...",
        "userName":"...",
        "execState":"...",
        "execDate":,
        "status":"...",
        "statusDetail":{
            "numOfCriticals":"...",
            "numOfWarnings":"...",
            "numOfNormals":"...",
            "numOfUnknowns":"...",
            "numOfNAs":"..."
        },
        "numOfTargets":"...",
        "lastActionDate":,
        "errorMessage":"...",
        "metricResults":[{
            "metricType":"...",
            "metricName":"...",
            "nodeType":"...",
            "componentType":"...",
            "nodeName":"...",
            "execState":"...",
            "status":"...",
            "numOfTargets":"...",
            "statusDetail":{
                "numOfCriticals":"...",
                "numOfWarnings":"...",
                "numOfNormals":"...",
                "numOfUnknowns":"...",
                "numOfNAs":"..."
            }
        },
        :
        ],
        "profileResults":[{
            "profileID":"...",
            "profileName":"...",
            "metricResults":[{
                "metricType":"...",
                "metricName":"...",
                "nodeType":"...",
                "componentType":"...",
                "nodeName":"...",
                "execState":"...",
                "status":"...",
                "numOfTargets":"...",
                "statusDetail":{
                    "numOfCriticals":"...",
                    "numOfWarnings":"...",
                    "numOfNormals":"...",
                    "numOfUnknowns":"...",
                    "numOfNAs":"..."
                }
            },
            :
            ]
        },
        :
        ],
        "profileID":"..."
}

PredictionHistory (Type: PredictionHistory)

Attribute	Type	Description
name	string	Name of the predictive report result.
description	string	Description of the predictive report result.
reportID	string	ID of the predictive report result.
userName	string	Name of the user associated with the executed predictive operation.
execState	enum	Task status. (For details about the valid values, see the table PredictionExecState in List of enumerators.)
execDate	datetime	Date and time when this task started executing.
status	enum	Aggregated status of all the performance resources for the predictive report result. (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical Unknown NA
statusDetail	PredictionStatusDetail	Detail of the status.
numOfTargets	integer	Total number of targets.
lastActionDate	datetime	Date and time when the last action executed.
errorMessage	string	Error message for the result.
metricResults	PredictionTargetMetric[]	Result information per metric.
profileResults	PredictionProfileResult[]	Result information per profile.
profileID	string	Profile ID of this profile result for the history.

statusDetail (Type: PredictionStatusDetail)

Attribute	Type	Description
numOfCriticals	integer	Number of critical status incidents.
numOfWarnings	integer	Number of warning status incidents.
numOfNormals	integer	Number of normal status incidents.
numOfUnknowns	integer	Number of unknown status incidents.
numOfNAs	integer	Number of NA status incidents.

metricResults (Type: PredictionTargetMetric)

Attribute	Type	Description
metricType	enum	Metric type. (For details about the valid values, see the table MetricType in List of enumerators.)
metricName	string	Metric name.
nodeType	enum	Node type for this resource. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
componentType	enum	Component type for this resource. (For details about the valid values, see the table ComponentType in List of enumerators.)
nodeName	string	Node name.
execState	enum	Status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.)
status	enum	Status of the predictive result. (For details about the valid values, see the table ElementStatusType in List of enumerators.)
numOfTargets	integer	Total number of targets for this metric.
statusDetail	PredictionStatusDetail	Details for the predictive status.

statusDetail (Type: PredictionStatusDetail)

Attribute	Type	Description
numOfCriticals	integer	Number of critical status incidents.
numOfWarnings	integer	Number of warning status incidents.
numOfNormals	integer	Number of normal status incidents.
numOfUnknowns	integer	Number of unknown status incidents.
numOfNAs	integer	Number of NA status incidents.

profileResults (Type: PredictionProfileResult)

Attribute	Type	Description
profileID	string	Profile ID.
profileName	string	Profile name.
metricResults	PredictionTargetMetric[]	Result information associated with each metric.

metricResults (Type: PredictionTargetMetric)

Attribute	Type	Description
metricType	enum	Metric type. (For details about the valid values, see the table MetricType in List of enumerators.)
metricName	string	Metric name.
nodeType	enum	Node type for this resource. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
componentType	enum	Component type for this resource. (For details about the valid values, see the table ComponentType in List of enumerators.)
nodeName	string	Node name.
execState	enum	Status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.)
status	enum	Status of the predictive result. (For details about the valid values, see the table ElementStatusType in List of enumerators.)
numOfTargets	integer	Total number of targets for this metric.
statusDetail	PredictionStatusDetail	Details for the predictive status.

statusDetail (Type: PredictionStatusDetail)

Attribute	Type	Description
numOfCriticals	integer	Number of critical status incidents.
numOfWarnings	integer	Number of warning status incidents.
numOfNormals	integer	Number of normal status incidents.
numOfUnknowns	integer	Number of unknown status incidents.
numOfNAs	integer	Number of NA status incidents.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
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.