CreateScheduledPreloadJob - Edge Security Acceleration - Alibaba Cloud Documentation Center

Adds a scheduled prefetch task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
esa:CreateScheduledPreloadJob	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InsertWay	string	Yes	The method to submit URLs to be prefetched. Valid values: textBox oss	oss
Name	string	Yes	The name of the scheduled prefetch task.	example
OssUrl	string	No	The URL of the OSS object that stores the URLs to be prefetched.	https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	190007158391808
UrlList	string	No	The URLs to be prefetched. This parameter is required if you set InsertWay to textBox.	http://testurl.com/a.txt http://testurl.com/b.txt

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247B78
AliUid	string	The ID of the Alibaba Cloud account.	15685865xxx14622
CreatedAt	string	The time when the task was created.	2023-06-05T10:04:20+0800
Domains	string	The domain names to be prefetched.	testurl.com
ErrorInfo	string	The error message. Multiple error messages are separated by commas (,). Valid values: InvalidUrl: The URL format is invalid. InvalidDomain: The domain name fails the domain ownership verification. QuotaExcess: the quota limit has been reached. OtherErrors: other errors.	InvalidDomain
FailedFileOss	string	The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.	https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7
FileId	string	The ID of the URL list file, which can be used during downloads.	665d3b48621bccf3fe29e1a7
Id	string	The ID of the scheduled prefetch task.	665d3af3621bccf3fe29e1a4
InsertWay	string	The method to submit the URLs to be prefetched.	oss
Name	string	The task name.	example
SiteId	long	The website ID.	190007158391808
TaskSubmitted	integer	The number of submitted prefetch tasks.	1
TaskType	string	The task type (refresh or preload).	preload
UrlCount	integer	The total number of URLs.	2
UrlSubmitted	integer	The number of submitted URLs.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247B78",
  "AliUid": "15685865xxx14622",
  "CreatedAt": "2023-06-05T10:04:20+0800",
  "Domains": "testurl.com",
  "ErrorInfo": "InvalidDomain",
  "FailedFileOss": "https://xxxobject.oss-cn-reginon.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.

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