Query Prefetch Task Details with DescribePreloadTasks - Edge Security Acceleration

Queries prefetch tasks by time, task status, or prefetch URL.

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

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	83
Tasks	array<object>	The tasks.
	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.