DescribeDcdnRefreshTaskById - Edge Security Acceleration

Queries the status of refresh or prefetch tasks by task ID.

Operation description

Note

You can query data within the last three days.
You can call this operation up to 30 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	Yes	The ID of the task that you want to query. The following signature algorithms require different message digest algorithms: Perform the RefreshDcdnObjectCaches operation to query refresh task IDs. Perform the PreloadDcdnObjectCaches operation to query prefetch task IDs. Note You can specify at most 10 task IDs in each call. Separate IDs with commas (,).	113681**

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of tasks.	2
RequestId	string	The request ID.	E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasks	array<object>	A list of prefetch or refresh tasks.
CDNTask	object
Status	string	The task status. Valid values: Complete: The task is complete. Pending: The task is pending. Refreshing: The task is running. Failed: The task failed.	Complete
CreationTime	string	The time when the task was created. The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.	2021-05-10T08:54:23Z
ObjectType	string	The type of the refresh or prefetch task. Valid values: file: refreshes an individual file. directory: refreshes files under the specified directory. preload: prefetches an individual file.	file
Process	string	The progress of the task, in percentage.	100%
Description	string	The error returned when the refresh or prefetch task failed. Valid values: Internal Error: An internal error occurred. Origin Timeout: The response from the origin server timed out. Origin Return StatusCode 5XX: The origin server returned a 5XX error.	Internal Error
ObjectPath	string	The path of the refresh or prefetch object.	http://example.com/image_01.png
TaskId	string	The ID of the task.	113681**

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2021-05-10T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/image_01.png",
      "TaskId": "113681**"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	The specified parameters are invalid.	A parameter is set to an invalid value.
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	The value specified for the TaskId parameter is invalid.
400	InvalidTaskId	The maximum number of taskIds is 10.	The number of task IDs (taskIds) cannot exceed 10.
400	InvalidTime	The query time cannot exceed the last 3 days.	You can query data up to the last three days.
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

No change history