CreateScheduledTask
Description
creates timing tasks based on incoming parameters.
Request Method
POST
Request Path
/apsara/route/Ess/CreateScheduledTask
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| LaunchTime | BODY | string | Yes | No sample value for this parameter. | the time point at which the scheduled task is triggered. According to ISO8601 standards, UTC time is required. The format is: YYYY-MM-DDThh:mmZ. If a RecurrenceType is specified, the point in time specified by this attribute defaults to the point in time when the loop is executed. If no RecurrenceType is specified, it is executed once on the specified date and time. You cannot fill in the time after 90 days from the day of creation or modification. |
| Description | BODY | string | No | No sample value for this parameter. | description information of the scheduled task. 2-200 English or Chinese characters. |
| RecurrenceType | BODY | string | No | No sample value for this parameter. | the type of scheduled task to be executed repeatedly. Optional value: Daily: how many days do you repeat the scheduled tasks. Weekly: Repeat the scheduled task every specified few days per week. Monthly: specify a few days each month to repeat the scheduled task. RecurrenceType, RecurrenceValue and RecurrenceEndTime need to be specified at the same time. |
| ScheduledTaskName | BODY | string | No | No sample value for this parameter. | the display name of the scheduled task, 2-40 English or Chinese characters, starting with numbers, large and small letters or Chinese, and can contain numbers, "_", "-" or ".". The same user account is unique in the same region. If this parameter is not specified, the default value is ScheduledScalingTaskId. |
| version | BODY | string | No | 2016-01-01 | version of api |
| LaunchExpirationTime | BODY | integer | No | No sample value for this parameter. | retry within this time after the scheduled task trigger operation fails. The default is 600 seconds. Value range:[0, 21600] |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| RegionId | BODY | string | Yes | No sample value for this parameter. | the region ID of the scheduled task. |
| ScheduledAction | BODY | string | Yes | No sample value for this parameter. | actions to be performed when a scheduled task is triggered. Enter the unique identifier of the scaling rule here. |
| RecurrenceValue | BODY | string | No | No sample value for this parameter. | the value of repeating the scheduled task. Daily: Only one value can be filled in, and the value range is:[1,31]. Weekly: You can fill in multiple values. Sunday, Monday... Saturday's values are: 0, 1,2,..., 6. Many days are separated by the English character. Monthly: format is A- B. The value range of A and B is [1,31], and B must be greater than or equal to A. RecurrenceType, RecurrenceValue and RecurrenceEndTime need to be specified at the same time. |
| RecurrenceEndTime | BODY | string | No | No sample value for this parameter. | the end time of repeated execution of scheduled tasks. According to ISO8601 standards, UTC time is required. The format is: YYYY-MM-DDThh:mmZ cannot be filled in 90 days after the day of creation or modification. RecurrenceType, RecurrenceValue and RecurrenceEndTime need to be specified at the same time. |
| TaskEnabled | BODY | bool | No | No sample value for this parameter. | whether to start a scheduled task. true: start the scheduled task. false: stop the scheduled task. default value: true. |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}