Trigger Scheduled Prefetch Jobs via StartScheduledPreloadExecution API - Edge Security Acceleration

Start a scheduled prefetch using a prefetch plan ID.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	Prefetch plan ID.	665d3b48621bccf3fe29e1a7

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	Request ID.	65C66B7B-671A-8297-9187-2R5477247B76
Id	string	Prefetch plan ID.	665d3b48621bccf3fe29e1a7
StartTime	string	Start time of the scheduled prefetch plan.	2024-05-31T17:10:48.849+08:00
EndTime	string	End time of the scheduled prefetch plan.	2024-05-31T18:10:48.849+08:00
Interval	integer	Time interval between batches of scheduled prefetches, in seconds.	60
SliceLen	integer	Number of URLs per batch of scheduled prefetches.	10
Status	string	Status of the scheduled prefetch plan. Valid values: waiting: Waiting to run. running: Running. finished: Completed. failed: Failed. stopped: Paused.	waiting
JobId	string	Prefetch task ID.	665d3af3621bccf3fe29e1a4
AliUid	string	Alibaba Cloud account ID.	15685865xxx14622

Examples

Success response

JSON format

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "Id": "665d3b48621bccf3fe29e1a7",
  "StartTime": "2024-05-31T17:10:48.849+08:00",
  "EndTime": "2024-05-31T18:10:48.849+08:00",
  "Interval": 60,
  "SliceLen": 10,
  "Status": "waiting",
  "JobId": "665d3af3621bccf3fe29e1a4",
  "AliUid": "15685865xxx14622"
}

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.