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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVodRefreshTasks

系统规定参数。取值:DescribeVodRefreshTasks

TaskId String 70422****

按任务ID查询刷新状态。

ObjectPath String http://example.com/***.txt

按路径查询,准确匹配。

PageNumber Integer 1

页码。

ObjectType String file

任务类型。取值范围:

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

域名。

Status String Complete

任务状态。取值:

  • Complete:完成。
  • Refreshing:刷新中。
  • Failed:刷新失败。
PageSize Integer 20

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

StartTime String 2017-01-01T12:12:20Z

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

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

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

返回数据

名称 类型 示例值 描述
PageNumber Long 1

页码。

PageSize Long 10

整页大小。

RequestId String 174F6032-AA26-470D-****-36F0EB205BEE

请求ID。

Tasks Array of Task

TaskItem组成的Task任务列表。

Task
CreationTime String 2014-11-27T08:23:22Z

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

Description String Internal Error

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

  • Internal Error:内部错误。
  • Origin Timeout:源站响应超时。
  • Origin Return StatusCode 5XX:源站返回5XX状态码。
ObjectPath String http://example.com/****.txt

刷新对象路径。

ObjectType String file

任务类型。取值:

  • file默认:文件刷新。
  • directory:目录刷新。
  • preload:文件预热。
Process String 100%

进度百分比。

Status String Complete

状态。取值:

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

任务ID。

TotalCount Long 2

总条数。

示例

请求示例

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

正常返回示例

XML 格式

<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>

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"
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

Throttling

Request was denied due to request throttling.

503

请求被流量控制限制。

OperationDenied

Your account does not open VOD service yet.

403

账号未开通视频点播服务。

OperationDenied.Suspended

Your VOD service is suspended.

403

账号已欠费,请充值。

InvalidTaskId.Malformed

Specified TaskId is malformed.

400

TaskId格式错误。