CancelScheduleTasks - PolarDB

Cancels scheduled tasks that are not yet started.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:CancelScheduleTasks	Write	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information of all clusters that are deployed in a specified region, such as the cluster IDs.	pc-**************
TaskId	string	Yes	The ID of the scheduled task that you want to cancel. 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 IDs. You can cancel only the tasks whose status is `pending`.``	ec8c4723-eac5-4f12-becb-01ac08******
ResourceGroupId	string	No	The ID of the resource group.	rg-************

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7F2007D3-7E74-4ECB-89A8-BF130D******
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.

For a list of error codes, visit the Service error codes.