DescribeDcdnRefreshTasks - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the refresh or prefetch tasks. You can query the tasks in the last three days.

Operation description

You can query the refresh or prefetch tasks by ID or URL.
You can set both TaskId and ObjectPath in a request. If you do not set TaskId or ObjectPath, the data in the last 3 days on the first page is returned. By default, a maximum of 20 entries can be displayed on each page.
If you specify DomainName or Status, you must also specify ObjectType.
You can call this operation up to 10 times per second per account.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the task. A task ID is assigned when you create a refresh or prefetch task.	704225667
ObjectPath	string	No	The path of the object. The path is used as a condition for exact matching.	http://example.com/examplefile.txt
PageNumber	integer	No	The number of the page to return. Valid values: 1 to 100000.	2
ObjectType	string	No	The type of the task. file: URL-based refresh directory: directory-based refresh preload: URL-based prefetch If you set DomainName or Status, you must also set this parameter.	file
DomainName	string	No	The accelerated domain name. You can specify only one domain name in each request.	example.com
Status	string	No	The status of the task. Complete: The task is complete. Refreshing: The task is in progress. Failed: The task failed.	Complete
PageSize	integer	No	The number of entries to return on each page. Default value: 20. Maximum value: 50. Valid values: 1 to 50.	20
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-01T12:12:20Z
EndTime	string	No	The end of the time range to query. 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.	2017-01-01T12:13:20Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumber	long	The page number of the returned page.	2
PageSize	long	The number of entries returned per page.	2
TotalCount	long	The number of tasks.	20
Tasks	array<object>	Details about tasks.
Task	object
Status	string	The status of the task. Complete: The task is complete. Refreshing: The task is in progress. Failed: The task failed.	Complete
CreationTime	string	The time when the task was created. The time is displayed in UTC.	2014-11-27T08:23:22Z
ObjectType	string	The type of the task. file: URL-based refresh path: directory-based refresh preload: URL-based prefetch	file
Process	string	The progress of the task in percentage.	10
Description	string	The type of error returned when the refresh or prefetch task has failed. InternalError: An internal error occurred. OriginTimeout: The response from the origin server timed out. OriginReturn StatusCode 5XX: The origin server returned a 5XX error.	InternalError
ObjectPath	string	The URL of the object refreshed.	http://example.com/examplefile.txt
TaskId	string	The ID of the task.	123

Examples

Sample success responses

JSONformat

{
  "RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
  "PageNumber": 2,
  "PageSize": 2,
  "TotalCount": 20,
  "Tasks": {
    "Task": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "10",
        "Description": "InternalError",
        "ObjectPath": "http://example.com/examplefile.txt",
        "TaskId": "123"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	The value specified for the TaskId parameter is invalid.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Specify the ObjectType parameter.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	The number of domain names cannot exceed 500.
400	InvalidTime	The query time cannot exceed the last 3 days.	You can query data up to the last three days.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.	The specified ObjectType parameter is invalid.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.	The specified Status parameter is invalid.
429	TooManyRequests	The server is busy. Please try again later.	The server is unavailable. Try again later.

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

Change history

Change time	Summary of changes	Operation
2023-03-28	The Error code has changed	View Change Details
2023-03-23	The Error code has changed	View Change Details