DescribeRefreshTaskById - CDN - Alibaba Cloud Documentation Center

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

Operation description

You can query data in the last three days.
You can call this operation up to 30 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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. You can call the RefreshObjectCaches operation to query task IDs. Then, you can use the task IDs to query task status. You can specify up to 10 task IDs. Separate task IDs with commas (,).	12345678

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of tasks.	2
RequestId	string	The ID of the request.	E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasks	array<object>	Details about tasks.
	object
Status	string	The status of the task. Valid values: Complete Pending Refreshing Failed	Complete
CreationTime	string	The time when the task was created. The time is displayed in UTC.	2020-08-03T08:54:23Z
ObjectType	string	The type of the task. Valid values: file: refreshes an individual file. directory: refreshes files in the specified directory. preload: prefetches an individual file. regex: refreshes content based on a regular expression.	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 Origin Timeout Origin Return StatusCode 5XX	Internal Error
ObjectPath	string	The path of the object refreshed by the refresh task.	http://example.com/abc.jpg
TaskId	string	The ID of the task.	24840

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2020-08-03T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/abc.jpg",
      "TaskId": "24840"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	-
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.	-
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	-
400	InvalidStartTime.Malformed	The specified StartTime is invalid.	The format of the start time is invalid. Specify a valid value.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The EndTime parameter is set in an invalid format. For more information, see the API references.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	EndTime is earlier than StartTime.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid. For more information, see the API references.
400	InvalidEndTime.ValueNotSupported	The specified EndTime is invalid.	-
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.	-
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.	-
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	-
400	InvalidTaskId.Malformed	The count of taskIds should be between 1 and 10.	-
400	InvalidParameters	The parameters you provided are invalid.	-
400	InvalidTime	The query time cannot exceed the last 3 days.	-
429	TooManyRequests	Too many requests, please 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