All Products
Document Center


Last Updated:Mar 28, 2024

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.


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

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
  • All Resources

Request parameters


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 (,).


Response parameters


The total number of tasks.


The ID of the request.

Tasksobject []

Details about tasks.


The status of the task. Valid values:

  • Complete
  • Pending
  • Refreshing
  • Failed

The time when the task was created. The time is displayed in UTC.


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.

The progress of the task, in percentage.


The error returned when the refresh or prefetch task failed. Valid values:

  • Internal Error
  • Origin Timeout
  • Origin Return StatusCode 5XX
Internal Error

The path of the object refreshed by the refresh task.

The ID of the task.



Sample success responses


  "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": "",
      "TaskId": "24840"

Error codes

HTTP status codeError codeError messageDescription
400InvalidTaskId.MalformedThe specified TaskId is invalid.-
400InvalidObjectPath.MalformedThe specified ObjectPath is invalid.-
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400MissingParameter.ObjectTypeThe ObjectType parameter is required if DomainName or ObjectType is specified.-
400InvalidStartTime.MalformedThe specified StartTime is invalid.The format of the start time is invalid. Specify a valid value.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The EndTime parameter is set in an invalid format. For more information, see the API references.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.EndTime is earlier than StartTime.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid. For more information, see the API references.
400InvalidEndTime.ValueNotSupportedThe specified EndTime is invalid.-
400InvalidObjectType.ValueNotSupportedThe specified ObjectType is not supported.-
400InvalidStatus.ValueNotSupportedThe specified Status is not supported.-
400DomainNameOverLimitA maximum of 500 domains are supported for each request.-
400InvalidTaskId.MalformedThe count of taskIds should be between 1 and 10.-
400InvalidParametersThe parameters you provided are invalid.-
400InvalidTimeThe query time cannot exceed the last 3 days.-
429TooManyRequestsToo many requests, please try again later-

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

Change history

Change timeSummary of changesOperation
No change history