Reset Scheduled Preload Jobs from Scratch with ResetScheduledPreloadJob API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Resets the progress of a scheduled prefetch task and restarts the prefetch from the beginning. Before calling this operation, you must first create a scheduled prefetch task by calling CreateScheduledPreloadJob to obtain a valid task ID, and then pass the ID to this operation for resetting.

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:ResetScheduledPreloadJob

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The ID of the scheduled prefetch task. Important The ID of the scheduled prefetch task. This parameter is required. You can obtain the ID from the response of CreateScheduledPreloadJob after creating a task, or query the ID of an existing task by calling GetScheduledPreloadJob or ListScheduledPreloadJobs. .	665d3af3621bccf3fe29e1a4

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
AliUid	string	The Alibaba Cloud account ID.	15685865xxx14622
CreatedAt	string	The time when the task was created, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).	2024-06-02T02:23:26Z
Domains	string	The list of domain names to prefetch.	testurl.com
ErrorInfo	string	The error message.	invalid domain:test.com
FailedFileOss	string	The OSS URL of the failed file.	https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7
FileId	string	The ID of the URL list file, which is used for downloading.	665d3b48621bccf3fe29e1a7
Id	string	The task ID.	665d3af3621bccf3fe29e1a4
InsertWay	string	The URL insertion method. Valid values: oss: URLs are imported in batches from an OSS file. testBox: URLs are entered one by one in a text box. Valid values: oss : URLs are imported in batches from an OSS file. testBox : URLs are entered one by one in a text box.	oss
Name	string	The task name.	example
SiteId	integer	The site ID.	190007158391808
TaskSubmitted	integer	The number of URLs that have been submitted to the system for prefetching.	1
TaskType	string	The task type (refresh or prefetch). Valid values: path: directory refresh. refresh: URL refresh. preload: URL prefetch. Valid values: path : Directory refresh. refresh : URL refresh. preload : URL prefetch.	preload
UrlCount	integer	The total number of URLs.	2
UrlSubmitted	integer	The number of submitted URLs.	1

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "AliUid": "15685865xxx14622",
  "CreatedAt": "2024-06-02T02:23:26Z",
  "Domains": "testurl.com",
  "ErrorInfo": "invalid domain:test.com",
  "FailedFileOss": "https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7",
  "FileId": "665d3b48621bccf3fe29e1a7",
  "Id": "665d3af3621bccf3fe29e1a4",
  "InsertWay": "oss",
  "Name": "example",
  "SiteId": 190007158391808,
  "TaskSubmitted": 1,
  "TaskType": "preload",
  "UrlCount": 2,
  "UrlSubmitted": 1
}

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.