DescribeVodRefreshTasks - 查询刷新和预热状态

调用DescribeVodRefreshTasks查询刷新和预热状态是否生效。

接口说明

说明
  • 目前服务地址仅支持:华东2(上海)
  • 若Taskid与Objectpath都不指定,则默认查询3天内,第一页的数据(20条)。Taskid与Objectpath可以同时指定。
  • 调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    TaskIdstring

    按任务ID查询刷新状态。

    70422****
    ObjectPathstring

    按路径查询,准确匹配。

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

    页码。

    1
    ObjectTypestring

    任务类型。取值范围:

    • file:文件刷新。
    • directory:目录刷新。
    • preload:文件预热。
    说明当指定DomainName或Status时,ObjectType该项为必填。
    file
    DomainNamestring

    域名。

    example.com
    Statusstring

    任务状态。取值:

    • Complete:完成。
    • Refreshing:刷新中。
    • Failed:刷新失败。
    Complete
    PageSizeinteger

    分页大小,每页显示的条目数。默认值:20。最大值:50

    20
    StartTimestring

    开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

    说明仅能查询3天内的数据。
    2017-01-01T12:12:20Z
    EndTimestring

    结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

    2017-01-01T12:30:20Z

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

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

    页码。

    1
    PageSizeLong

    整页大小。

    10
    TotalCountLong

    总条数。

    2
    Tasksarray

    TaskItem组成的Task任务列表。

    object
    Statusstring

    状态。取值:

    • Complete:完成。
    • Refreshing:刷新中。
    • Failed:刷新失败。
    • Pending:等待刷新。
    Complete
    CreationTimestring

    任务对象创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

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

    任务类型。取值:

    • file默认:文件刷新。
    • directory:目录刷新。
    • preload:文件预热。
    file
    Processstring

    进度百分比。

    100%
    Descriptionstring

    刷新预热失败返回的错误描述。目前有三种:

    • Internal Error:内部错误。
    • Origin Timeout:源站响应超时。
    • Origin Return StatusCode 5XX:源站返回5XX状态码。
    Internal Error
    ObjectPathstring

    刷新对象路径。

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

    任务ID。

    704225667

    示例

    请求示例

    https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribeVodRefreshTasks
    &<公共请求参数>
    

    正常返回示例

    JSON格式

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

    XML格式

    <?xml version="1.0" encoding="utf-8"?>
    <DescribeVodRefreshTasksResponse>
      <Tasks>
        <Task>
          <CreationTime>2014-11-27T08:23:22Z</CreationTime>
          <ObjectPath>http://example.com/****.txt</ObjectPath>
          <Status>Complete</Status>
          <TaskId>704225667</TaskId>
          <ObjectType>file</ObjectType>
          <Process>100%</Process>
        </Task>
        <Task>
          <CreationTime>2014-11-27T08:18:38Z</CreationTime>
          <ObjectPath>http://example.com/****.txt</ObjectPath>
          <Status>Complete</Status>
          <TaskId>704222904</TaskId>
          <ObjectType>file</ObjectType>
          <Process>100%</Process>
        </Task>
      </Tasks>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <TotalCount>2</TotalCount>
      <RequestId>13DF2E2F-FBF8-4E1C-****-98141795443D</RequestId>
    </DescribeVodRefreshTasksResponse>

    错误码

    访问错误中心查看更多错误码。

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
    OperationDeniedYour account does not open VOD service yet.403账号未开通视频点播服务。
    OperationDenied.SuspendedYour VOD service is suspended.403账号已欠费,请充值。
    InvalidTaskId.MalformedSpecified TaskId is malformed.400TaskId格式错误。
    阿里云首页 视频点播 相关技术圈