Executing a predictive operation
You can execute and cancel tasks for the predictive operation. In addition, you can obtain a list of task-related actions for the predictive operation.
Getting a list of predictive tasks
You can obtain a list of predictive tasks.
Admin, Modify
GET baseURL/v1/objects/PredictionTask
Not applicable.
Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
data |
anyType[] | A list of PredictionTask objects. For details about PredictionTask, 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. |
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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. |
Getting information about a predictive task
You can obtain information about a predictive task.
Admin, Modify
GET baseURL/v1/objects/PredictionTask/{id}
Not applicable.
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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. |
Getting a list of predictive-related operations
You can obtain a list of predictive-related operations.
Admin, Modify
GET baseURL/v1/services/PredictionTask/actions
Not applicable.
Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
data |
anyType[] | A list of Action objects. For details about Action, 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. |
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 objects necessary to execute an operation. No value is set. |
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. |
Preparing to predict a result
Following is the initial step required to predict a result.
Admin, Modify
GET baseURL/v1/services/PredictionTask/actions/execute
Not applicable.
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 PredictionExecParam objects necessary to execute an operation. For details about PredictionExecParam, see the table below. |
PredictionExecParam
{ "reportID":"...", "profileIDs":["...", ...], "targetConds":[{ "nodeType":"...", "resourceIDs":["...", ...], "withRelated":"..." }, : ], "metrics":[{ "metricType":"...", "threshold":"...", "proportion":"..." }, : ], "withRelated":"...", "predictionPeriod":"...", "calculationPeriod":"..." }
PredictionExecParam (Type: PredictionExecParam)
Attribute |
Type |
Description |
reportID |
string |
ID of the predictive risk report. |
profileIDs |
string[] |
List of predictive risk profile IDs. |
targetConds |
PredictionTargetCond[] |
Target condition list. |
metrics |
PredictionMetric[] |
Target metric information list. |
withRelated |
boolean |
Whether or not the related resources are included in the targets. |
predictionPeriod |
long |
Time period of the predictive result. |
calculationPeriod |
long |
Time period it took to predict the result. |
targetConds (Type: PredictionTargetCond)
Attribute |
Type |
Description |
nodeType |
enum |
Node type. (For details about the valid values, see the table E2ENodeType in List of enumerators.) |
resourceIDs |
string[] |
Resource ID list. |
withRelated |
boolean |
Indicates whether the related resource is the same as the target. |
metrics (Type: PredictionMetric)
Attribute |
Type |
Description |
metricType |
enum |
Metric type. (For details about the valid values, see the table MetricType in List of enumerators.) |
threshold |
float |
A threshold value. |
proportion |
boolean |
Direction of threshold. |
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. |
Predicting a result
You can predict a result.
Admin, Modify
POST baseURL/v1/services/PredictionTask/actions/execute/invoke
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 PredictionExecParam objects necessary to execute an operation. For details about PredictionExecParam, see the table below. |
PredictionExecParam
{ "reportID":"...", "profileIDs":["...", ...], "targetConds":[{ "nodeType":"...", "resourceIDs":["...", ...], "withRelated":"..." }, : ], "metrics":[{ "metricType":"...", "threshold":"...", "proportion":"..." }, : ], "withRelated":"...", "predictionPeriod":"...", "calculationPeriod":"..." }
PredictionExecParam (Type: PredictionExecParam)
Attribute |
Type |
Description |
reportID |
string |
ID of the predictive risk report. |
profileIDs |
string[] |
List of predictive risk profile IDs. |
targetConds |
PredictionTargetCond[] |
Target condition list. |
metrics |
PredictionMetric[] |
Target metric information list. |
withRelated |
boolean |
Whether or not the related resources are included in the targets. |
predictionPeriod |
long |
Time period of the predictive result. |
calculationPeriod |
long |
Time period it took to predict the result. |
targetConds (Type: PredictionTargetCond)
Attribute |
Type |
Description |
nodeType |
enum |
Node type. (For details about the valid values, see the table E2ENodeType in List of enumerators.) |
resourceIDs |
string[] |
Resource ID list. |
withRelated |
boolean |
Indicates whether the related resource is the same as the target. |
metrics (Type: PredictionMetric)
Attribute |
Type |
Description |
metricType |
enum |
Metric type. (For details about the valid values, see the table MetricType in List of enumerators.) |
threshold |
float |
A threshold value. |
proportion |
boolean |
Direction of threshold. |
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 PredictionTask objects. For details about PredictionTask, see the table below. |
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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. |
Preparing to cancel a predictive operation
Following is the initial step required to cancel a predictive operation.
Admin, Modify
GET baseURL/v1/services/PredictionTask/actions/cancel
Not applicable.
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 PredictionTask objects necessary to execute an operation. For details about PredictionTask, see the table below. |
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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. |
Canceling a predictive operation
You can cancel a predictive operation.
Admin, Modify
POST baseURL/v1/services/PredictionTask/actions/cancel/invoke
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 PredictionTask objects necessary to execute an operation. For details about PredictionTask, see the table below. |
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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 PredictionTask objects. For details about PredictionTask, see the table below. |
PredictionTask
{ "name":"...", "taskState":"..." }
PredictionTask (Type: PredictionTask)
Attribute |
Type |
Description |
name |
string |
Name of the task. |
taskState |
enum |
Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.) |
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. |