Get Scheduler Execution Report

GET/zstack/v1/scheduler/report

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/scheduler/report?startTime=1.5856704E12&intervalTimeUnit=Month&range=4.0&schedulerJobTypes=vmBackup

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
startTime	long	query	Report start time		3.9.0
intervalTimeUnit	String	query	Interval time unit	Hour Month	3.9.0
range	int	query	Report time range		3.9.0
schedulerJobTypes	List	query	Scheduler job types		3.9.0
systemTags (optional)	List	query			3.9.0
userTags (optional)	List	query			3.9.0

API Response

Response Example

{
  "successRecords": [
    100.0,
    99.0,
    50.0,
    0.0
  ],
  "failureRecords": [
    0.0,
    1.0,
    34.0,
    0.0
  ],
  "partialSuccessRecords": [
    0.0,
    0.0,
    16.0,
    0.0
  ],
  "waitingRecords": [
    0.0,
    0.0,
    0.0,
    100.0
  ]
}

Name	Type	Description	Starting Version
successRecords	List	Success records	3.9.0
failureRecords	List	Failure records	3.9.0
partialSuccessRecords	List	Partial success records	3.9.0
waitingRecords	List	Waiting for execution records	3.9.0
success	boolean		3.9.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error	3.9.0
error	ErrorCode	For details, see error	3.9.0

error

Name	Type	Description	Starting Version
code	String	Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001	3.9.0
description	String	Brief description of the error	3.9.0
details	String	Detailed information about the error	3.9.0
elaboration	String	Reserved field. Default is null	3.9.0
opaque	LinkedHashMap	Reserved field. Default is null	3.9.0
cause	ErrorCode	Root error. The source error that caused the current error. This field is null if there is no source error	3.9.0

error

Name	Type	Description	Starting Version
code	String	Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001	3.9.0
description	String	Brief description of the error	3.9.0
details	String	Detailed information about the error	3.9.0
elaboration	String	Reserved field. Default is null	3.9.0
opaque	LinkedHashMap	Reserved field. Default is null	3.9.0
cause	ErrorCode	Root error. The source error that caused the current error. This field is null if there is no source error	3.9.0

SDK Examples

Java SDK

GetSchedulerExecutionReportAction action = new GetSchedulerExecutionReportAction();
action.startTime = 1.5856704E12;
action.intervalTimeUnit = "Month";
action.range = 4.0;
action.schedulerJobTypes = asList("vmBackup");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetSchedulerExecutionReportAction.Result res = action.call();

Python SDK

GetSchedulerExecutionReportAction action = GetSchedulerExecutionReportAction()
action.startTime = 1.5856704E12
action.intervalTimeUnit = "Month"
action.range = 4.0
action.schedulerJobTypes = [vmBackup]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetSchedulerExecutionReportAction.Result res = action.call()