Skip to content

Query Scheduled Task Details

API Address:/v2/cep/enduserapi/v2/getCronJobInfo

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Query scheduled task details

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
ruleIdScheduled task rule IDquerytruestring
Authorizationheaderfalsestring

Response Status:

Status CodeDescriptionSchema
200OKApiResult«Scheduled Task Details»
401Unauthorized
403Forbidden
404Not Found
5041No permission
5593Please enter scheduled task ID
5594Failed to query scheduled task

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeinteger(int32)integer(int32)
dataScheduled Task DetailsScheduled Task Details
  cacheTimeDownstream cache time, in seconds, value range: 0-7776000integer(int64)
  createTimeCreation timeinteger(int64)
  dayOfWeekRepeat cycle, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday, multiple separated by comma, when type = custom-repeatmulti-section
  deviceKeyDevice KEYstring
  enabledScheduled task status, true: enabled, false: disabledboolean
  productKeyProduct KEYstring
  ruleIdScheduled task rule IDstring
  timeZoneTimezone, format: +-HH:mmstring
  timersScheduled task list, when type = multi-section, scheduled task quantity is limited to 2-5arrayScheduled Task Res
    actionCommand executed by scheduled task, format: Thing model JSON stringstring
    cacheTimeDownstream cache time, in seconds, value range: 0-7776000integer
    delayDelayed execution time, in seconds, required when type = delayinteger
    taskLogoTask iconstring
    taskNameTask namestring
    timeExecution time, format: HH:mm:ss, when type = onceday-repeat
    timerIdScheduled task IDstring
  typeScheduled task type, once: execute once, day-repeat: repeat daily, custom-repeat: repeat weekly, multi-section: multi-stage execution, delay: countdownstring
extMsgstring
msgstring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"cacheTime": 0,
		"createTime": 0,
		"dayOfWeek": "",
		"deviceKey": "",
		"enabled": true,
		"productKey": "",
		"ruleId": "",
		"timeZone": "",
		"timers": [
			{
				"action": "",
				"cacheTime": 0,
				"delay": 0,
				"taskLogo": "",
				"taskName": "",
				"time": "",
				"timerId": ""
			}
		],
		"type": ""
	},
	"extMsg": "",
	"msg": ""
}