Cancels a specified scheduled task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No CancelScheduleTasks

The operation that you want to perform. Set the value to CancelScheduleTasks.

DBClusterId String Yes pc-**************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.
TaskId String Yes ec8c4723-eac5-4f12-becb-01ac08******

The ID of the scheduled task to be canceled.

Note
  • You can call the DescribeScheduleTasks operation to query the details of all scheduled tasks that belong to the current account, such as the task ID.
  • You can cancel only the tasks whose satus is pending.

Response parameters

Parameter Type Example Description
RequestId String 7F2007D3-7E74-4ECB-89A8-BF130D******

The ID of the request.

Success Boolean true

The result of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=CancelScheduleTasks
&DBClusterId=pc-**************
&TaskId=ec8c4723-eac5-4f12-becb-01ac08******
&<Common request parameters>

Sample success responses

XML format

<CancelScheduleTasksResponse>
  <RequestId>7F2007D3-7E74-4ECB-89A8-BF130D******</RequestId>
  <Success>true</Success>
</CancelScheduleTasksResponse>

JSON format

{
	"RequestId": "7F2007D3-7E74-4ECB-89A8-BF130D******",
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.