All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnRefreshTaskById

Last Updated:Mar 01, 2024

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

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:DescribeDcdnRefreshTaskByIdRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringYes

The ID of the task that you want to query. The following signature algorithms require different message digest algorithms:

Note You can specify at most 10 task IDs in each call. Separate IDs with commas (,).
113681**

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of tasks.

2
RequestIdstring

The request ID.

E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasksobject []

A list of prefetch or refresh tasks.

Statusstring

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
CreationTimestring

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
ObjectTypestring

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
Processstring

The progress of the task, in percentage.

100%
Descriptionstring

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
ObjectPathstring

The path of the refresh or prefetch object.

http://example.com/image_01.png
TaskIdstring

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 codeError codeError messageDescription
400InvalidParametersThe specified parameters are invalid.A parameter is set to an invalid value.
400InvalidTaskId.MalformedThe specified TaskId is invalid.The value specified for the TaskId parameter is invalid.
400InvalidTaskIdThe maximum number of taskIds is 10.The number of task IDs (taskIds) cannot exceed 10.
400InvalidTimeThe query time cannot exceed the last 3 days.You can query data up to the last three days.
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
No change history