Getting metrics for the predictive result

Execution permission

Admin, Modify

Request line

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

PredictionTargetMetric

{
        "metricType":"...",
        "metricName":"...",
        "nodeType":"...",
        "componentType":"...",
        "nodeName":"...",
        "execState":"...",
        "status":"...",
        "numOfTargets":"...",
        "statusDetail":{
            "numOfCriticals":"...",
            "numOfWarnings":"...",
            "numOfNormals":"...",
            "numOfUnknowns":"...",
            "numOfNAs":"..."
        }
}

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

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

PredictionTarget

{
        "execState":"...",
        "status":"...",
        "firstAlertDate":
}

PredictionTarget (Type: PredictionTarget)

Attribute	Type	Description
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.)
firstAlertDate	datetime	Estimated date and time when the value exceeds or falls below the threshold.

Attribute

Type

Description

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

firstAlertDate

datetime

Estimated date and time when the value exceeds or falls below 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.