All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodRefreshTasks

    Document Center

    ApsaraVideo VOD:DescribeVodRefreshTasks

    Last Updated:Jul 21, 2026

    Queries whether purge and prefetch tasks have taken effect.

    Operation description

    • Currently, the service address supports only China (Shanghai).

    • If neither Taskid nor Objectpath is specified, the first page of data (20 entries) within the last 3 days is returned by default. Taskid and Objectpath can be specified at the same time.

    • When DomainName or Status is specified, ObjectType is required.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vod:DescribeVodRefreshTasks

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskId

    string

    No

    The task ID used to query the purge status.

    70422****
    ObjectPath

    string

    No

    The path used to query. Exact match is used.

    http://example.com/***.txt
    PageNumber

    integer

    No

    The page number.

    1
    ObjectType

    string

    No

    The task type. Valid values:

    • file: file purge.

    • directory: directory purge.

    • preload: file prefetch.

    Note

    When DomainName or Status is specified, ObjectType is required.

    file
    DomainName

    string

    No

    The domain name.

    example.com
    Status

    string

    No

    The task status. Valid values:

    • Complete: completed.

    • Refreshing: in progress.

    • Failed: failed.

    Complete
    PageSize

    integer

    No

    The number of entries per page. Default value: 20. Maximum value: 50.

    20
    StartTime

    string

    No

    The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    Note

    Only data within the last 3 days can be queried.

    2017-01-01T12:12:20Z
    EndTime

    string

    No

    The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2017-01-01T12:30:20Z

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    174F6032-AA26-470D-****-36F0EB205BEE
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The page size.

    10
    TotalCount

    integer

    The total number of entries.

    2
    Tasks

    object

    Task

    array<object>

    The list of tasks composed of TaskItem objects.

    object

    Status

    string

    The status of the task. Valid values:

    • Complete: The task is complete.

    • Refreshing: The task is in progress.

    • Failed: The task failed.

    • Pending: The task is pending.

    Complete
    CreationTime

    string

    The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

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

    string

    The type of the task. Default value: file. Valid values:

    • file: refreshes one or more files.

    • directory: refreshes files in the specified directory.

    • preload: prefetches one or more files.

    file
    Process

    string

    The progress of the task in percentage.

    100%
    Description

    string

    The type of error returned when the refresh or prefetch task failed. Valid values: 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 an HTTP status code 5xx.

    Internal Error
    ObjectPath

    string

    The URL of the object refreshed.

    http://example.com/****.txt
    TaskId

    string

    The ID of the task.

    704225667

    Examples

    Success response

    JSON format

    {
  "RequestId": "174F6032-AA26-470D-****-36F0EB205BEE",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Tasks": {
    "Task": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/****.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidTaskId.Malformed The specified TaskId is invalid. Invalid TaskId
    400 MissingTimeParameter The StartTime and EndTime must be both specified. Both start time and end must be specified
    400 MissingParameter.ObjectType The ObjectType parameter is required if DomainName or ObjectType is specified.
    400 InvalidStartTime.Malformed The specified StartTime is invalid.
    400 InvalidEndTime.Malformed The specified EndTime is invalid.
    400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. End time is earlier than start time
    400 InvalidStartTime.ValueNotSupported The specified StartTime 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. Up to 500 domain names per request
    400 InvalidTime The query time cannot exceed the last 3 days. The request time cannot be returned for more than 3 days.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.