All Products
Search
Document Center

Edge Security Acceleration:ListScheduledPreloadJobs

Last Updated:Nov 07, 2025

Queries the scheduled prefetch tasks for a website.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListScheduledPreloadJobsget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

The website ID.

ListScheduledPreloadJobs
StartTimelongNo

The beginning of the task creation time range to query. Specify the timestamp in milliseconds.

1717225276000
EndTimelongNo

The end time for querying the task creation time range. Specify the timestamp in milliseconds.

1717225277000
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
TotalCountstring

The total number of tasks returned.

5
Jobsarray<object>

The list of the prefetch tasks.

jobsobject

The details of prefetch tasks.

AliUidstring

The ID of the Alibaba Cloud account.

15685865xxx14622
CreatedAtstring

The time when the task was created.

2024-06-01T08:53:13Z
Domainsstring

The domain names to be prefetched.

testurl.com
ErrorInfostring

The error message that is returned.

invalid domain:test.com
FailedFileOssstring

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
FileIdstring

The ID of the URL list file, which can be used during downloads.

665d3b48621bccf3fe29e1a7
Idstring

The ID of the prefetch task.

665d3af3621bccf3fe29e1a4
InsertWaystring

The method to submit the URLs to be prefetched.

oss
Namestring

The task name.

example
SiteIdlong

The website ID.

190007158391808
TaskSubmittedinteger

The number of submitted prefetch tasks.

1
TaskTypestring

The task type. Valid values: refresh and preload.

preload
UrlCountinteger

The total number of URLs.

2
UrlSubmittedinteger

The number of submitted URLs.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "TotalCount": 5,
  "Jobs": [
    {
      "AliUid": "15685865xxx14622",
      "CreatedAt": "2024-06-01T08:53:13Z",
      "Domains": "testurl.com",
      "ErrorInfo": "invalid domain:test.com",
      "FailedFileOss": "https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7",
      "FileId": "665d3b48621bccf3fe29e1a7",
      "Id": "665d3af3621bccf3fe29e1a4\n",
      "InsertWay": "oss",
      "Name": "example",
      "SiteId": 190007158391808,
      "TaskSubmitted": 1,
      "TaskType": "preload",
      "UrlCount": 2,
      "UrlSubmitted": 1
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time you entered is earlier than the start time. Please check and try again.
400InvalidJob.JobCountOfSiteFullThe 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.
400InvalidParameter.ObjectIdInvalid task ID or execution plan ID.Invalid task ID or execution plan ID.
400MissingOssUrlOssUrl 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.
400MissingUrlListEnter the URLs you want to prefetch.Enter the URLs you want to prefetch.
400TooManyRequestsToo many requests.Please try again later.Requests are too frequent, please try again later.
403InvalidUid.PermissionDeniedYou 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.
404InvalidJob.NotFoundThe 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.
404LogNotFoundFailed 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.
404InvalidExecution.NotFoundThe 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.

Change history

Change timeSummary of changesOperation
2025-03-13The Error code has changed. The response structure of the API has changedView Change Details