文档

DescribeVodRefreshTasks - 查询刷新和预热状态

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

接口说明

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

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

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:DescribeVodRefreshTasksList
    • 全部资源
      *

    请求参数

    名称类型必填描述示例值
    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
    Tasksobject []

    TaskItem 组成的 Task 任务列表。

    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

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    接口错误码

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

    错误代码错误信息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 格式错误。