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

调用该接口前,请您注意

  • 支持根据任务ID和URL查询。
  • TaskId与ObjectPath都不指定,默认查3天内,第一页的数据(20条)。
  • TaskId与ObjectPath可以同时指定。
  • 当指定DomainName或TaskStatus时,ObjectType该项为必填。
  • 只可查询3天内的数据。

调试

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

请求参数

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

系统规定参数,取值:DescribeRefreshTasks

TaskId String 70422****

按任务ID查询刷新状态。

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

按路径查询,准确匹配。

PageNumber Integer 1

取得第几页,取值范围为1~100000

ObjectType String file

任务类型。取值:

  • file
  • path
  • preload

当指定DomainNameTaskStatus时,该项为必填。

DomainName String example.com

域名。

Status String Complete

任务状态。取值:

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

分页大小,默认20,最大50。取值为1~50之前的任意整数。

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

开始时间。

EndTime String 2017-01-01T12:13:20Z

结束时间。

ResourceGroupId String rg-acfmyuji4b6****

资源组ID。

返回数据

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

当前页码。

PageSize Long 10

分页大小。

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

请求ID。

Tasks Array of Task

SCDNTask组成的任务列表。

Task
CreationTime String 2014-11-27T08:18:38Z

任务对象创建时间,UTC时间。

Description String Internal Error

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

  • InternalError
  • OriginTimeout
  • OriginReturn StatusCode 5XX
ObjectPath String http://example.com/examplefile.txt

刷新对象路径。

ObjectType String file

任务类型。取值:

  • file
  • path
  • preload
Process String 100%

进度百分比。

Status String Complete

状态。取值:

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

任务ID。

TotalCount Long 2

总个数。

示例

请求示例

http(s)://scdn.aliyuncs.com/?Action=DescribeScdnRefreshTasks
&<公共请求参数>

正常返回示例

XML格式

<TotalCount>2</TotalCount>
<Tasks>
    <Task>
        <Status>Complete</Status>
        <ObjectType>file</ObjectType>
        <ObjectPath>http://example.com/examplefile.txt</ObjectPath>
        <Description>Internal Error</Description>
        <TaskId>704225667</TaskId>
        <CreationTime>2014-11-27T08:18:38Z</CreationTime>
        <Process>100%</Process>
    </Task>
</Tasks>
<PageSize>10</PageSize>
<RequestId>174F6032-AA26-470D-B90E-36F0EB205BEE</RequestId>
<PageNumber>1</PageNumber>

JSON格式

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