Lists scheduled prefetch jobs for a site.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
Site ID |
190007158391808 |
| StartTime |
integer |
No |
Start of the time range for querying job creation time, in milliseconds since the UNIX epoch. |
1717225276000 |
| EndTime |
integer |
No |
End of the time range for querying job creation time, in milliseconds since the UNIX epoch. |
1717225277000 |
| PageNumber |
integer |
No |
Page number to retrieve. |
1 |
| PageSize |
integer |
No |
Number of entries per page. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Request ID. |
CB1A380B-09F0-41BB-A198-72F8FD6DA2FE |
| TotalCount |
string |
Total number of records after filtering. |
5 |
| Jobs |
array<object> |
List of prefetch job details. |
|
|
object |
Prefetch job information. |
||
| AliUid |
string |
Alibaba Cloud account ID. |
15685865xxx14622 |
| CreatedAt |
string |
Job creation time. |
2024-06-01T08:53:13Z |
| Domains |
string |
List of domains to prefetch. |
testurl.com |
| ErrorInfo |
string |
Error message. |
invalid domain:test.com |
| FailedFileOss |
string |
The OSS address of the failed file. |
https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7 |
| FileId |
string |
URL list file ID (used for downloading). |
665d3b48621bccf3fe29e1a7 |
| Id |
string |
Job ID. |
665d3af3621bccf3fe29e1a4 |
| InsertWay |
string |
URL insertion method. |
oss |
| Name |
string |
Job name. |
example |
| SiteId |
integer |
Site ID |
190007158391808 |
| TaskSubmitted |
integer |
Number of URLs submitted to the system for prefetching. |
1 |
| TaskType |
string |
Task type (refresh or prefetch). |
preload |
| UrlCount |
integer |
Total number of URLs. |
2 |
| UrlSubmitted |
integer |
Number of URLs submitted. |
1 |
| ExecutionCount |
integer |
Number of prefetch schedules. |
1 |
Examples
Success response
JSON format
{
"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,
"ExecutionCount": 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.