Getting predictive results

You can obtain predictive results.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/PredictionHistory/actions/getResult/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 GetPredictionResultParam objects necessary to execute an operation. For details, see the table below.

GetPredictionResultParam

{
        "historyID":"...",
        "targetIDs":"...",
        "cullTimespan":"...",
        "rangeFrom":"...",
        "rangeTo":"...",
        "onlyModelData":"..."
}

GetPredictionResultParam (Type: GetPredictionResultParam)

Attribute	Type	Description
historyID	string	ID of the predictive report result.
targetIDs	string	Target ID list.
cullTimespan	int	Interval (in minutes) for culling display data.
rangeFrom	long	Start time of the performance data range.
rangeTo	long	End time of the performance data range.
onlyModelData	boolean	Whether the response will have performance data and predictive report results.

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[]	A list of PredictionTargetResult objects. For details, see the table below.
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.

PredictionTargetResult

{
        "originalData":{
            "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":"..."
            },
            :
            ]
        },
        "resultData":[{
            "label":"...",
            "description":"...",
            "resultType":"...",
            "data":{
                "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":"..."
                },
                :
                ]
            },
            "thresholdScore":"...",
            "thresholdAlertDate":,
            "status":"..."
        },
        :
        ],
        "execState":"...",
        "errorMessage":"...",
        "model":{
            "instanceID":"...",
            "componentID":"...",
            "componentName":"...",
            "label":"...",
            "metricType":"...",
            "status":"...",
            "predictionStatus":"...",
            "parentNodeID":"...",
            "parentNodeName":"...",
            "hypervisorName":"...",
            "clusterName":"...",
            "thresholdProfileName":"...",
            "poolName":"...",
            "pgName":"...",
            "nvmHostNicknames":["...", ...],
            "hostGroupIDs":["...", ...],
            "hostGroupNames":["...", ...],
            "realPerformanceLatest":"...",
            "realPerformanceWorst":"...",
            "predictionPerformanceWorst":"...",
            "firstAlertDate":
        }
}

PredictionTargetResult (Type: PredictionTargetResult)

Attribute	Type	Description
originalData	E2EPerformanceGraphData	Original data.
resultData	PredictionResult[]	A list of the predictive report results.
execState	enum	Status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.)
errorMessage	string	Error message of the result.
model	PredictionPerfModel	Resource information.

originalData (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.

resultData (Type: PredictionResult)

Attribute	Type	Description
label	string	Label of the predictive results.
description	string	Description of the predictive results.
resultType	enum	Type of the predictive result. (For details about the valid values, see the table PredictionResultType in List of enumerators.)
data	E2EPerformanceGraphData	Data of the predictive result.
thresholdScore	float	Score of the predictive result for threshold.
thresholdAlertDate	datetime	Estimated date when the specified threshold is violated.
status	enum	Status of the predictive result. (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical NA

data (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.

model (Type: PredictionPerfModel)

Attribute	Type	Description
instanceID	string	ID of the performance resource.
componentID	string	ID of a resource.
componentName	string	Name of a resource.
label	string	Label of a resource.
metricType	enum	ID of the metric. (For details about the valid values, see the table MetricType in List of enumerators.)
status	enum	Status of the performance information. (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical LinkDown Unknown NA NotMonitored NotCollected Info
predictionStatus	enum	Status of each predictive result line. (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical NA
parentNodeID	string	ID of the device that a component belongs to.
parentNodeName	string	Name of the device that a component belongs to.
hypervisorName	string	Name of the hypervisor.
clusterName	string	Name of the cluster.
thresholdProfileName	string	Name of the threshold profile.
poolName	string	Name of the pool.
pgName	string	Name of the parity group.
nvmHostNicknames	string[]	NVM host nickname of the volume.
hostGroupIDs	string[]	ID of the host group that a volume belongs to.
hostGroupNames	string[]	Name of the host group that a volume belongs to.
realPerformanceLatest	float	Latest real performance value.
realPerformanceWorst	float	Worst real performance value.
predictionPerformanceWorst	float	Worst performance value of predictive results.
firstAlertDate	datetime	First date and time when the performance value exceeds the threshold.

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 execute privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.