Cancel Scheduled Prefetch Plans with the API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Stops a single scheduled preload execution plan based on the preload plan ID. Prerequisites: (1) This API only takes effect when the execution plan status is running. Execution plans in the waiting or failed status cannot be stopped. (2) Whether an execution plan can reach the running status depends on whether the site it belongs to has completed access verification (site Status=active).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:StopScheduledPreloadExecution

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The preload plan ID, obtained from the SuccessExecutions[].Id field returned by CreateScheduledPreloadExecutions. Before calling this API, you must first create a preload task by calling CreateScheduledPreloadJob, and then create an execution plan by calling CreateScheduledPreloadExecutions.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.
Id	string	The preload plan ID.
StartTime	string	The start time of the scheduled preload plan, in ISO 8601 format (e.g., 2024-01-01T00:00:00+Z).
EndTime	string	The end time of the scheduled preload plan, in ISO 8601 format (e.g., 2024-01-01T00:00:00+Z).
Interval	integer	The execution interval between batches in the scheduled preload plan, in seconds.
SliceLen	integer	The number of URLs per batch in the scheduled preload.
Status	string	The status of the scheduled preload plan. Valid values: waiting: Waiting to be executed. running: Being executed. finished: Execution completed. failed: Execution failed. stopped: Execution paused.
JobId	string	The preload task ID.
AliUid	string	The Alibaba Cloud account ID.

Examples

Success response

JSON format

{
  "RequestId": "",
  "Id": "",
  "StartTime": "",
  "EndTime": "",
  "Interval": 0,
  "SliceLen": 0,
  "Status": "",
  "JobId": "",
  "AliUid": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	InvalidJob.JobCountOfSiteFull	The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.	The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.
400	InvalidParameter.ObjectId	Invalid task ID or execution plan ID.	Invalid task ID or execution plan ID.
400	MissingOssUrl	OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.	OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.
400	MissingUrlList	Enter the URLs you want to prefetch.	Enter the URLs you want to prefetch.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
403	InvalidUid.PermissionDenied	You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.	You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.
404	InvalidJob.NotFound	The task does not exist. Check whether the task ID is correct or whether the task has been deleted.	The task does not exist. Check whether the task ID is correct or whether the task has been deleted.
404	LogNotFound	Failed to query the log. Check whether the task ID and execution ID are valid.	Failed to query the log. Check whether the task ID and execution ID are valid.
404	InvalidExecution.NotFound	The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.	The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.