Automate Prefetch Scheduling via ESA OpenAPI - Edge Security Acceleration

Plan to batch add scheduled prefetch tasks.

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	No	The ID of the prefetch task. The ID is generated by calling the CreateScheduledPreloadJob operation.	665d3af3621bccf3fe29e1a4
Executions	array<object>	Yes	The list of execution plans for scheduled prefetch tasks to be added.
	object	No	The information about an execution plan.
StartTime	string	No	The start time of the scheduled prefetch plan.	2024-06-03T16:00:00Z
EndTime	string	No	The end time of the scheduled prefetch plan.	2024-06-04T02:02:09Z
Interval	integer	Yes	The interval at which batches of a scheduled prefetch plan are executed. Unit: seconds.	30
SliceLen	integer	Yes	The number of URLs to prefetch in each batch.	10

Response elements

Element	Type	Description	Example
	object	Schema of response
RequestId	string	The ID of the request.	F61CDR30-E83C-4FDA-BF73-9A94CDD44229
FailedExecutions	array<object>	The information about the prefetch plans that failed to be added.
	object
Id	string	The ID of the prefetch plan.	66599bd7397885b43804901c
StartTime	string	The start time of the scheduled prefetch plan.	2024-06-02T02:43:35Z
EndTime	string	The end time of the scheduled prefetch plan.	2024-06-03T02:43:35Z
Interval	integer	The interval at which batches of a scheduled prefetch plan are executed. Unit: seconds.	60
SliceLen	integer	The number of URLs to prefetch in each batch.	10
Status	string	The status of the scheduled prefetch plan. Valid values: waiting: The plan is waiting to be executed. running: The plan is being executed. finished: The plan is executed. failed: The plan failed to be executed. stopped: The execution of the plan is paused.	running
JobId	string	The ID of the prefetch task.	665d3af3621bccf3fe29e1a4
AliUid	string	The ID of the Alibaba Cloud account.	15685865xxx14622
FailedMessages	array	The list of error messages for the plans that failed to be added.
	string	The error message.	execution id: 66599bd7397885b43804921c, error: end time is before start time.
SuccessCount	integer	The number of prefetch plans that were successfully added.	12
SuccessExecutions	array<object>	The information about the prefetch plans that were successfully added.
	object
Id	string	The ID of the prefetch plan.	66599bd7397885b43804901c
StartTime	string	The start time of the scheduled prefetch plan.	2024-06-02T02:43:35Z
EndTime	string	The end time of the scheduled prefetch plan.	2024-06-03T02:43:35Z
Interval	integer	The interval at which batches of a scheduled prefetch plan are executed. Unit: seconds.	60
SliceLen	integer	The number of URLs to prefetch in each batch.	10
Status	string	The status of the scheduled prefetch plan. Valid values: waiting: The plan is waiting to be executed. running: The plan is being executed. finished: The plan is executed. failed: The plan failed to be executed. stopped: The execution of the plan is paused.	failed
JobId	string	The ID of the prefetch task.	665d3af3621bccf3fe29e1a4
AliUid	string	The ID of the Alibaba Cloud account.	15685865xxx14622
TotalCount	integer	The total number of plans that you requested to add.	2

Examples

Success response

JSON format

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "FailedExecutions": [
    {
      "Id": "66599bd7397885b43804901c",
      "StartTime": "2024-06-02T02:43:35Z",
      "EndTime": "2024-06-03T02:43:35Z",
      "Interval": 60,
      "SliceLen": 10,
      "Status": "running",
      "JobId": "665d3af3621bccf3fe29e1a4",
      "AliUid": "15685865xxx14622"
    }
  ],
  "FailedMessages": [
    "execution id: 66599bd7397885b43804921c, error: end time is before start time."
  ],
  "SuccessCount": 12,
  "SuccessExecutions": [
    {
      "Id": "66599bd7397885b43804901c",
      "StartTime": "2024-06-02T02:43:35Z",
      "EndTime": "2024-06-03T02:43:35Z",
      "Interval": 60,
      "SliceLen": 10,
      "Status": "failed",
      "JobId": "665d3af3621bccf3fe29e1a4",
      "AliUid": "15685865xxx14622"
    }
  ],
  "TotalCount": 2
}

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.