DescribePreloadTasks - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the details of prefetch tasks by time, task status, or prefetch URL.

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:DescribePreloadTasks	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	No	The website ID. You can call the ListSites operation to obtain the ID.	123456789****
Content	string	No	The content to prefetch. Exact match is supported.	http://a.com/1.jpg?b=2
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Valid values: 1 to 50.	20
StartTime	string	No	The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-03-22T17:00:00Z
EndTime	string	No	The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time.	2023-03-23T06:23:00Z
Status	string	No	The task status. Valid values: Complete: The task is complete. Refreshing: The task is running. Failed: The task failed.	Complete

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageNumber	long	The page number.	1
PageSize	long	The number of entries per page.	10
TotalCount	long	The total number of entries returned.	83
Tasks	array<object>	The tasks.
Task	object
Status	string	The task status. Complete: The task is complete. Refreshing: The task is in progress. Failed: The task failed.	Complete
CreateTime	string	The time when the task was created.	2023-03-28 14:28:57
Process	string	The progress of the task, in percentage.	100%
Description	string	The error message returned upon a prefetch task failure. Valid values: Internal Error Origin Timeout Origin Return StatusCode 5XX	Internal Error
Content	string	The prefetched content.	http://a.com/1.jpg?b=2
TaskId	string	The ID of the queried task.	1597854579687428

Examples

Sample success responses

JSONformat

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 83,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-03-28 14:28:57",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=2",
      "TaskId": 1597854579687428
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Please provide both a start time and an end time.
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	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.
400	InvalidTime	The query time cannot exceed the last 3 days.	The query time cannot exceed the last 3 days.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Specify the ObjectType parameter.
400	InvalidStationParameter	The specified Station is invalid.	The specified node parameter is invalid.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidTaskId.Malformed	The specified taskId is invalid.	The specified task ID is invalid.
400	InvalidParameters.InvalidUrls	The specified urls are invalid.	The requested URL parameter is invalid.

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