全部产品
Search
文档中心

CDN:DescribeRefreshTasks - 查询刷新预热任务

更新时间:Dec 09, 2022

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

接口说明

  • 支持根据任务ID或URL查询。
  • 支持同时传入TaskIdObjectPath参数,如果不指定TaskIdObjectPath,默认查询最近3天内第一页的数据(20条)。
  • 只可查询最近3天内的数据。
  • 如果您在OSS控制台开启了CDN缓存自动刷新,则无法通过DescribeRefreshTasks接口查看OSS上的缓存自动刷新任务。
  • 单用户调用频率:10次/秒。如果您需要更高的调用频率,请使用仅支持通过任务编号查询刷新预热任务信息的接口DescribeRefreshTaskById

调试

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

调试

授权信息

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

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

请求参数

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

按任务ID查询刷新状态。

1234321
ObjectPathstring

按路径查询,准确匹配。

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

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

1
ObjectTypestring

任务类型。取值:

  • file:文件刷新。

  • directory:目录刷新。

  • regex:正则刷新。

  • preload:文件预热。

说明当指定DomainNameStatus参数时,ObjectType参数为必传参数。
file
DomainNamestring

加速域名。仅支持单个查询,默认查询所有加速域名。

example.com
Statusstring

任务状态。取值:

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

分页大小,默认20,最大100。取值:1~100

20
StartTimestring

开始时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

2017-12-21T08:00:00Z
EndTimestring

结束时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明结束时间需大于起始时间。
2017-12-22T08:00:00Z
ResourceGroupIdstring

资源组ID。

rg-acfmyuji4b6r4**

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumberlong

页码。

10
PageSizelong

整页大小。

1
TotalCountlong

总条数。

2
Tasksarray

任务列表。

object
Statusstring

状态。

  • Complete:完成。

  • Refreshing:刷新中。

  • Failed:刷新失败。

  • Pending:等待刷新。

Complete
CreationTimestring

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

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

任务类型。

  • file:文件刷新。

  • directory:目录刷新。

  • regex:正则刷新。

  • preload:文件预热。

file
Processstring

进度百分比。

100%
Descriptionstring

刷新预热失败返回的错误描述。

  • InternalError:内部错误。

  • OriginTimeout:源站响应超时。

  • OriginReturnStatusCode 5XX:源站响应5xx错误码。

Internal Error
ObjectPathstring

刷新对象路径。

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

任务ID。

704225667

示例

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息描述
400InvalidTaskId.MalformedThe specified TaskId is invalid.-
400MissingParameter.ObjectTypeThe ObjectType parameter is required if DomainName or Status is specified.-
400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.-
400DomainNameOverLimitA maximum of 500 domains are supported for each request.-
400InvalidTimeThe query time cannot exceed the last 3 days.-
400InvalidStartTime.MalformedThe specified StartTime is invalid.-
400InvalidEndTime.MalformedThe specified EndTime is invalid.-
400InvalidObjectPath.MalformedThe specified ObjectPath is invalid.-
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.-
400InvalidEndTime.ValueNotSupportedThe specified EndTime is invalid.-
400InvalidObjectType.ValueNotSupportedThe specified ObjectType is not supported.-
400InvalidStatus.ValueNotSupportedThe specified Status is not supported.-
429TooManyRequestsThe server is busy. Please try again later.服务器正忙,请稍后再试。

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