调用DescribeRefreshTaskById查询刷新状态和预热状态是否在全网生效。

说明
  • 支持查询30天内的数据。
  • 单用户调用频率为30次/秒。

调试

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

请求参数

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

操作接口名，系统规定参数。取值：DescribeRefreshTaskById。

TaskId String 是 12345678

待查询的任务ID。

您可以调用RefreshObjectCaches接口，从其返回值中获取刷新预热的任务ID，并通过任务ID查询源站资源的刷新状态。支持同时传入多个任务ID，多个任务ID之间用英文逗号（,）分隔，最多支持同时传入10个任务ID。

返回数据

名称 类型 示例值 描述
RequestId String E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B

请求ID。
Tasks Array of CDNTask

任务列表。
CreationTime String 2020-08-03T08:54:23Z

任务对象创建时间，使用UTC时间表示。
Description String Internal Error

刷新预热失败后返回的错误描述。取值：

  • Internal Error：内部错误。
  • Origin Timeout：源站响应超时。
  • Origin Return StatusCode 5XX：源站响应5xx错误码。
ObjectPath String http://example.com/abc.jpg

刷新对象的路径。
ObjectType String file

任务类型。取值：

  • file：单文件刷新。
  • directory：目录刷新。
  • preload：单文件预热。
Process String 100%

任务完成进度百分比。
Status String Complete

任务状态。取值：

  • Complete：已完成。
  • Pending：等待刷新。
  • Refreshing：刷新中。
  • Failed：刷新失败。
TaskId String 12345678

查询到的任务ID。
TotalCount Long 2

任务总个数。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeRefreshTaskById
&TaskId=12345678
&<公共请求参数>

正常返回示例

XML格式 

<DescribeRefreshTaskByIdResponse>
  <RequestId>E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B</RequestId>
  <Tasks>
        <CreationTime>2020-08-03T08:54:23Z</CreationTime>
        <Description></Description>
        <ObjectPath>http://example.com/abc.jpg</ObjectPath>
        <ObjectType>file</ObjectType>
        <Process>100%</Process>
        <Status>Complete</Status>
        <TaskId>12345678</TaskId>
  </Tasks>
  <Tasks>
        <CreationTime>2020-08-03T09:12:44Z</CreationTime>
        <Description></Description>
        <ObjectPath>http://example.com/bcd.jpg</ObjectPath>
        <ObjectType>file</ObjectType>
        <Process>99.37%</Process>
        <Status>Refreshing</Status>
        <TaskId>23456789</TaskId>
  </Tasks>
  <TotalCount>2</TotalCount>
</DescribeRefreshTaskByIdResponse>

JSON格式 

{
    "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
    "Tasks": [
        {
            "CreationTime": "2020-08-03T08:54:23Z",
            "Description": "",
            "ObjectPath": "http://example.com/abc.jpg",
            "ObjectType": "file",
            "Process": "100%",
            "Status": "Complete",
            "TaskId": "12345678"
        },
        {
            "CreationTime": "2020-08-03T09:12:44Z",
            "Description": "",
            "ObjectPath": "http://example.com/bcd.jpg",
            "ObjectType": "file",
            "Process": "99.37%",
            "Status": "Refreshing",
            "TaskId": "23456789"
        }
    ],
    "TotalCount": 2
}

错误码

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