调用RefreshObjectCaches刷新节点上的文件内容。被刷新的文件缓存将立即失效,新的请求将回源获取最新的文件,支持URL批量刷新。
接口说明
- 请求方式:支持 POST 请求,参数用 form 表单显示。
- 相关接口:刷新预热类接口包含 RefreshObjectCaches 刷新接口和 PushObjectCache 预热接口。
- 单用户调用频率:50 次/秒。
- 如果您需要自动化刷新或预热,请参见刷新预热自动化脚本。
注意事项
- 提交刷新任务并成功执行后,CDN 节点上对应的缓存资源将会失效,当您再次发起访问请求时,节点会回源站拉取所需资源,并重新缓存在节点上,因此大批量提交刷新任务会清空较多缓存,导致回源带宽和请求突增,增加源站压力。
- 刷新任务从提交到生效,大约需要 5~6 分钟,如果文件或者目录配置的缓存过期时间少于 5 分钟,您无需执行刷新操作,等待文件或者目录缓存超时更新即可。
- 使用 RAM 用户来执行刷新或预热操作的,需要先获得授权,请参见授予 RAM 用户刷新预热权限完成授权。
URL 刷新配额
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:RefreshObjectCaches | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ObjectPath | string | 是 | 刷新 URL,格式为加速域名或刷新的文件或目录。 多个 URL 之间使用换行符(\n)或(\r\n)分隔。 | http://example.com/image/1.png\nhttp://aliyundoc.com/image/2.png |
ObjectType | string | 否 | 刷新任务类型,取值:
文件刷新和目录刷新的功能说明请参考刷新和预热资源,正则刷新的功能说明和操作示例请参考正则刷新说明。 文件刷新将直接删除节点上的资源,当有新请求时回源拉取新资源。其它刷新类型默认只刷新发生变更的资源,需要强制刷新请配置 Force 参数为 true,详见 Force 参数说明。 | File |
Force | boolean | 否 | 当回源内容和源站资源对比一致时,是否强制刷新对应范围内的资源。默认为 false。
说明
此参数生效范围:除文件刷新外的刷新类型
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RefreshTaskId": "704222901",
"RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SingleRequest.OverLimit | A maximum of 1000 URLs are supported for each request. | - |
400 | InvalidObjectType.Malformed | The specified ObjectType is invalid. | 指定的ObjectType无效。 |
400 | InvalidObjectPath.Malformed | The specified ObjectPath is invalid. | - |
400 | QuotaExceeded.Refresh | Your refresh attempts have exceeded the daily limit. | - |
400 | InvalidExtensiveDomain.ValueNotSupported | The specified ExtensiveDomain is not supported. | - |
400 | QuotaPerMinuteExceeded.Refresh | You tried to refresh too frequently, please try again later. | - |
400 | TooMany.Refresh | The refresh queue is full, please try again later. | - |
429 | TooManyRequests | Too many requests, please try again later | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |