All Products
Search

This Product

    DescribeRefreshTasks

    Document Center

    DescribeRefreshTasks

    Last Updated: May 27, 2020

    Description

    You can call this operation to query whether the refresh and push status has taken effect for the whole site.

    • Supports task ID query and URL query
    • If TaskId and ObjectPath are not specified, the system queries data on the first page (20 items) in the last 3 days by default.
    • TaskId and ObjectPath can be specified at the same time, with a logical relationship of AND.
    • Only the data from the last 3 days can be queried.

    Request parameters

    Name Type Required Description
    Action String Yes The operation that you want to perform.
    Set the value to DescribeRefreshTasks.
    TaskId String No Queries refresh status by task ID.
    ObjectPath String No Queries by directory.
    DomainName String Yes The domain name.
    ObjectType String Yes The task type (file, path, preload).
    Status String No The task status (Complete, Refreshing, or Failed).
    StartTime String No The start time, for example, 2017-01-01T12:12:20Z.
    EndTime String No The end time, for example, 2017-01-01T12:12:20Z.
    PageSize Integer No The page size. Default value: 20. Maximum value: 50. Value range: any integer from 1 to 50.
    PageNumber Integer No Retrieves a certain page number. Value range: 1 to 100000.

    Response parameters

    Name Type Description
    Tasks Struct The task list composed of TaskItem.
    PageSize Integer The full page size.
    PageNumber Integer The page number.
    TotalCount Integer The total number of items.
    TaskItem child node
    Name Type Description
    TaskId String The task ID.
    ObjectPath String Refreshes the object path.
    Status String The task status. Valid values: Complete, Refreshing, Failed, and Pending.
    Process String The task progress in percentage.
    ObjectType String The task type (file, path, preload).
    CreationTime DateTime The task item creation time. The UTC time zone is used.
    Description String The returned error code for refreshing or pushing failure. Valid values: Internal Error, Origin Timeout, and Origin Return StatusCode 5XX.

    Examples

    Sample requests

    1. https://vod.cn-shanghai.aliyuncs.com?&Action=DescribeRefreshTasks&DomainName=a.com&ObjectType=file&PageNumber=1&PageSize=10&<Common request parameter>

    Sample responses

    JSON format

    1. {
    2.     "Tasks" : {
    3.         "Task" : [{
    4.                 "CreationTime" : "2014-11-27T08:23:22Z",
    5.                 "ObjectPath" : "http://aaa.com/1.txt",
    6.                 "Status" : "Complete",
    7.                 "TaskId" : "704225667",
    8.                 "ObjectType" : "file",
    9.                 "Process" : "100%"
    10.             }, {
    11.                 "CreationTime" : "2014-11-27T08:18:38Z",
    12.                 "ObjectPath" : "http://bbb.com/1.txt",
    13.                 "Status" : "Complete",
    14.                 "TaskId" : "704222904",
    15.                 "ObjectType" : "file",
    16.                 "Process" : "100%"
    17.             }
    18.         ]
    19.     },
    20.     "PageNumber" : 1,
    21.     "PageSize" : 10,
    22.     "TotalCount" : 2,
    23.     "RequestId" : "174F6032-AA26-470D-B90E-36F0EB205BEE"
    24. }

    XML format

    1. <?xml version="1.0" encoding="utf-8"?>
    2. <DescribeRefreshTasksResponse>
    3.   <Tasks>
    4.     <Task>
    5.       <CreationTime>2014-11-27T08:23:22Z</CreationTime>
    6.       <ObjectPath>http://aaa.com/1.txt</ObjectPath>
    7.       <Status>Complete</Status>
    8.       <TaskId>704225667</TaskId>
    9.       <ObjectType>file</ObjectType>
    10.       <Process>100%</Process>
    11.     </Task>
    12.     <Task>
    13.       <CreationTime>2014-11-27T08:18:38Z</CreationTime>
    14.       <ObjectPath>http://bbb.com/1.txt</ObjectPath>
    15.       <Status>Complete</Status>
    16.       <TaskId>704222904</TaskId>
    17.       <ObjectType>file</ObjectType>
    18.       <Process>100%</Process>
    19.     </Task>
    20.   </Tasks>
    21.   <PageNumber>1</PageNumber>
    22.   <PageSize>10</PageSize>
    23.   <TotalCount>2</TotalCount>
    24.   <RequestId>13DF2E2F-FBF8-4E1C-9222-98141795443D</RequestId>
    25. </DescribeRefreshTasksResponse>

    Error codes

    Error code Error message HTTP status code Description
    Throttling Request was denied due to request throttling. 503 The error message returned when the request is restricted by traffic throttling.
    OperationDenied Your account does not open VOD service yet. 403 The error message returned when ApsaraVideo VOD is not activated for the account.
    OperationDenied.Suspended Your VOD service is suspended. 403 The error message returned when the account has overdue payments. Add fees to your account.
    InvalidTaskId.Malformed Specified TaskId is malformed. 400 The error message returned when the TaskId format is invalid.
    Free Trial Free Trial