All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnRefreshTasks

Last Updated:Mar 01, 2024

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

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
dcdn:DescribeDcdnRefreshTasksWRITE
  • domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the task. A task ID is assigned when you create a refresh or prefetch task.

704225667
ObjectPathstringNo

The path of the object. The path is used as a condition for exact matching.

http://example.com/examplefile.txt
PageNumberintegerNo

The number of the page to return. Valid values: 1 to 100000.

2
ObjectTypestringNo

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
DomainNamestringNo

The accelerated domain name. You can specify only one domain name in each request.

example.com
StatusstringNo

The status of the task.

  • Complete: The task is complete.
  • Refreshing: The task is in progress.
  • Failed: The task failed.
Complete
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. Maximum value: 50. Valid values: 1 to 50.

20
StartTimestringNo

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
EndTimestringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumberlong

The page number of the returned page.

2
PageSizelong

The number of entries returned per page.

2
TotalCountlong

The number of tasks.

20
Tasksobject []

Details about tasks.

Statusstring

The status of the task.

  • Complete: The task is complete.
  • Refreshing: The task is in progress.
  • Failed: The task failed.
Complete
CreationTimestring

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

2014-11-27T08:23:22Z
ObjectTypestring

The type of the task.

  • file: URL-based refresh
  • path: directory-based refresh
  • preload: URL-based prefetch
file
Processstring

The progress of the task in percentage.

10
Descriptionstring

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
ObjectPathstring

The URL of the object refreshed.

http://example.com/examplefile.txt
TaskIdstring

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 codeError codeError messageDescription
400InvalidTaskId.MalformedThe specified TaskId is invalid.The value specified for the TaskId parameter is invalid.
400MissingParameter.ObjectTypeThe ObjectType parameter is required if DomainName or ObjectType is specified.Specify the ObjectType parameter.
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time is earlier than the start time.
400DomainNameOverLimitA maximum of 500 domains are supported for each request.The number of domain names cannot exceed 500.
400InvalidTimeThe query time cannot exceed the last 3 days.You can query data up to the last three days.
400InvalidStartTime.MalformedThe 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.
400InvalidEndTime.MalformedThe 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.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.
400InvalidObjectType.ValueNotSupportedThe specified ObjectType is not supported.The specified ObjectType parameter is invalid.
400InvalidStatus.ValueNotSupportedThe specified Status is not supported.The specified Status parameter is invalid.
429TooManyRequestsThe 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 timeSummary of changesOperation
2023-03-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 429
2023-03-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 429