调用DescribePurgeTasks查询刷新任务执行情况-边缘安全加速-阿里云-边缘安全加速(ESA)-阿里云帮助中心

查询刷新任务的执行情况。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:DescribePurgeTasks

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

无

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	否	站点 ID，可通过调用 ListSites 接口获取。重要需始终指定 SiteId，未指定时将报错。	123456789****
Content	string	否	查询内容，精确匹配。	http://a.com/1.jpg?b=1
Type	string	否	任务类型，取值： file（默认值）：文件刷新。 cachetag：缓存标签刷新。 directory：目录刷新。 ignoreParams：去参数刷新。 hostname：主机名刷新。 purgeall：刷新站点下所有缓存。枚举值： cachetag : cachetag 刷新 hostname : 主机名刷新 file : 文件刷新 cachekey : cachekey 刷新 purgeall : 全站刷新 ignoreparams : 去参数刷新 directory : 目录刷新	file
PageNumber	integer	否	取得第几页。取值范围为：1~100000。	1
PageSize	integer	否	分页大小。默认值：20，最大值：50。取值为1~50之间的任意整数。	20
StartTime	string	否	开始时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-11-16T05:33:00Z
EndTime	string	否	结束时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需大于起始时间。	2022-11-18T15:59:59Z
Status	string	否	任务执行状态。取值： Complete：完成。 Refreshing：刷新中。 Failed：刷新失败。枚举值： Refreshing : 刷新中 Complete : 完成 Failed : 刷新失败	Complete

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	15C66C7B-671A-4297-9187-2C4477247A123425345
PageNumber	integer	页码。	1
PageSize	integer	整页大小。	20
TotalCount	integer	总条数。	15
Tasks	array<object>	任务列表。
	object
Status	string	状态。 Complete：完成。 Refreshing：刷新中。 Failed：刷新失败。	Complete
CreateTime	string	创建时间，格式为 ISO 8601（如 2024-01-01T00:00:00+Z）。	2023-07-26T01:56:15Z
Type	string	刷新任务类型，取值： file（默认值）：文件刷新。 cachetag：缓存标签刷新。 directory：目录刷新。 ignoreParams：去参数刷新。 hostname：主机名刷新。 purgeall：刷新站点下所有缓存。	file
Process	string	任务完成进度百分比。	100%
Description	string	刷新任务失败返回错误描述。	Internal Error
Content	string	刷新对象。	http://a.com/1.jpg?b=1
TaskId	string	任务 ID。	16346513304

示例

正常返回示例

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 15,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-07-26T01:56:15Z",
      "Type": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=1",
      "TaskId": "16346513304"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	请同时提供开始时间和结束时间。
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	您填入的结束时间早于开始时间，请检查后重试。
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	一次最多只支持500个域名，请减少域名重新请求。
400	InvalidTime	The query time cannot exceed the last 3 days.	查询时间不能超过最近3天。
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	请填写ObjectType参数。
400	InvalidStationParameter	The specified Station is invalid.	指定的节点参数无效。
400	TooManyRequests	Too many requests.Please try again later.	请求过于频繁，请稍后重试。
400	InvalidTaskId.Malformed	The specified taskId is invalid.	指定的任务ID无效。
400	InvalidParameters.InvalidUrls	The specified urls are invalid.	请求的URL参数无效。

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

变更历史

更多信息，参考变更详情。