调用PurgeCaches接口刷新文件目录全站等多种类型缓存-边缘安全加速-阿里云-边缘安全加速(ESA)-阿里云帮助中心

刷新节点上的文件内容。支持文件、目录、缓存标记、去参数、主机名及全站刷新。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

esa:PurgeCaches

create

*Site

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

无

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	123456789****
Type	string	是	刷新任务类型，取值： file（默认值）：文件刷新。 cachekey：cachekey 刷新。 cachetag：缓存标签刷新。 directory：目录刷新。 ignoreParams：去参数刷新。去参数指的是去除请求 URL 中?及?之后的参数，去参数刷新指的是用户先通过接口提交去参数后的 URL，然后用户提交的待刷新 URL 将会与已缓存资源的 URL 进行去参数匹配，如果已缓存资源的 URL 去参数以后与待刷新 URL 匹配，那么 CDN 节点将对缓存资源执行刷新处理。 hostname：主机名刷新。 purgeall：刷新站点下所有缓存。枚举值： cachetag : 刷新标签刷新 hostname : 主机名刷新 file : 文件刷新 cachekey : cachekey 刷新 purgeall : 刷新站点下所有缓存 ignoreparams : 去参数刷新 directory : 目录刷新	file
Content	object	否	刷新内容。
Files	array	否	文件刷新列表，类型为 file 时需要指定。
	any	否	文件刷新列表，类型为 file 时需要指定。说明每次最多 1000 条，每次最多包含 10 个不同域名。	["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]
CacheTags	array	否	缓存标记刷新列表，类型为 cachetag 时需要指定。
	string	否	缓存标记刷新列表，类型为 cachetag 时需要指定。说明每次最多 30 个。	["tag1", "tag2"]
Hostnames	array	否	主机名刷新列表，类型为 hostname 时需要指定。
	string	否	主机名刷新列表，类型为 hostname 时需要指定。说明每次最多 10 个域名。	["a.com", "b.com"]
IgnoreParams	array	否	忽略掉参数的文件列表，当类型为 ignoreParams 时需要指定。
	string	否	忽略掉参数的文件列表，当类型为 ignoreParams 时需要指定。说明每次最多 100 条，每次最多包含 10 个不同域名。	["http://a.com/1.jpg", "http://a.com/2.jpg"]
Directories	array	否	目录刷新列表，类型为 directory 时需要指定。
	string	否	目录刷新列表，类型为 directory 时需要指定。说明每次最多 100 条，每次最多包含 10 个不同域名。	["http://a.com/path1/", "http://a.com/path2/"]
PurgeAll	boolean	否	全站刷新标记。默认为 false，当类型为 purgeall 时指定为 true。	true
CacheKeys	array<object>	否	cachekey 刷新列表，类型为 cachekey 时需要指定。
	array<object>	否
Url	string	否	需要刷新的 URL 地址。	http://a.com/1.jpg?b=1
Headers	object	否	刷新时指定 cachekey 对应的头部信息，当对应自定义 cachekey 功能开关开启时，将根据指定头部生成 cachekey 进行刷新。 UserGeo：国家/地区国家/地区代码遵循 ISO 3166-2 标准。 UserDeviceType：设备类型，目前有如下三个枚举值 desktop tablet mobile UserLanguage：语言语言代码遵循 ISO 639-1 标准或者 BCP47 标准，例如：输入 zh，表示对语言为中文的内容进行刷新。
	string	否	cachekey 头部对应的值信息。	{"Url":"http://www.example.com/dog_picture.jpg","Headers":{"cat": "789", "Cookie": "test444=444;test333=333;test222=222", "UserGeo": "US", "UserDeviceType": "desktop","UserLanguage": "zh-CN"}}
Force	boolean	否	当回源内容和源站资源对比后不一致时，是否刷新对应目录下的资源。默认为 false。 true：刷新对应目录下的全部资源。 false：刷新对应目录下发生变更的资源。说明生效范围：目录刷新、缓存标签刷新、去参数刷新、主机名刷新及刷新站点下所有缓存。	true
EdgeComputePurge	boolean	否	用于边缘计算缓存资源的刷新，例如允许对使用边缘函数 CacheAPI 接口缓存的内容进行刷新。	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	ET5BF670-09D5-4D0B-BEBY-D96A2A528000
TaskId	string	任务 ID，当您创建刷新或预热任务，会返回任务 ID。	15940956620

示例

正常返回示例

JSON格式

{
  "RequestId": "ET5BF670-09D5-4D0B-BEBY-D96A2A528000",
  "TaskId": "15940956620"
}

错误码

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参数无效。
400	QuotaExceeded	You attempts have exceeded the daily limit.	超出当日配额限制。今日提交数量已用完。您可以通过配额接口查询今日的可使用次数。
400	InvalidParameter.RecordNotBelongToSite	The record name passed in does not belong to the current site.	传入的记录名不属于当前站点。
400	InvalidParameter.RecordNotProxied	The proxy is not turned on for the record name passed in.	传入的记录名未开启代理。
429	TooManyRequests	System load fluctuates, please try again later.	系统负载波动，请稍候重试。

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

变更历史

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