Deleting Timed Tasks

Last updated: 2018-08-21 16:21:27

1. API Description

This API (DeleteScheduledTask) is used to delete a specific scheduled task.
Domain for API request: scaling.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is DeleteScheduledTask.

Parameter Name Required Type Description
scalingGroupId Yes String Scaling group ID, indicating that the scheduled task to be deleted belongs to the scaling group. This parameter can be obtained by calling API Query Scaling Group List (DescribeScalingGroup).
scalingScheduledTaskId Yes String ID of scheduled task to be deleted. This parameter can be obtained by calling API Query Scheduled Task(DescribeScheduledTask).

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
codeDesc String Error code at business side. If the task succeeds, it will return "Success"; if the task fails, the specific business error reason will be returned.
message String Module error message description depending on API.

4. Error Codes

For common errors on this API, refer to AS Error Code.

5. Example

https://scaling.api.qcloud.com/v2/index.php?
&<Common request parameters>
&scalingGroupId=asg-xxx
&scalingScheduleTaskId=xxxx

Example of returned result is as follows. The code is 0, indicating that the scheduled task has been deleted successfully.

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",  
    "data":[]    
}