All Products
Search
Document Center

Alibaba Cloud CDN:DescribeRefreshTaskById

Last Updated:Jan 30, 2023

Queries the status of refresh or prefetch tasks by ID for an accelerated domain name.

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.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operateaccess levelResource typeconditional keywordAssociation operation
    cdn:DescribeRefreshTaskByIdRead
    • CDN
      acs:cdn:*:{#accountId}:*
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TaskIdstringYes

    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

    ParameterTypeDescriptionExample
    object
    TotalCountlong

    The total number of tasks.

    2
    RequestIdstring

    The ID of the request.

    E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
    Tasksarray

    The tasks.

    object
    Statusstring

    The status of the task. 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 is displayed in UTC.

    2020-08-03T08:54:23Z
    ObjectTypestring

    The type of the task. Valid values:

    • file: refreshes an individual file.
    • directory: refreshes files under the specified directory.
    • preload: prefetches an individual file.
    • regex: refreshes content based on a regular expression.
    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 object refreshed by the refresh task.

    http://example.com/abc.jpg
    TaskIdstring

    The ID of the task.

    24840

    Example

    Normal return example

    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 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 specified start time is invalid. For more information, see the API references.
    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.-
    400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.-
    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 API error center.