刷新缓存

  • 项目

源站内容更新后，希望将更新结果实时映射到 CDN 服务节点。 由于 Azure 内容分发网络有默认的缓存规则，或用户设置过的缓存规则，因此必须使用缓存刷新功能来清除节点上的缓存内容。 如果再次访问该文件，获得的文件将是更新后的文件。

可以对单个文件或批量文件进行强制缓存刷新。 每个订阅每天文件刷新额度为 2,000。 目录刷新配额为 500。 如果需要对此进行调整，请联系开发团队。

请求

方法 请求 URI
POST https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints/{endpointId}/purges?apiVersion=1.0

URI 参数

参数名称 描述
subscriptionId 订阅唯一标识符
endpointId 目标节点唯一标识符

请求头

请求标头 说明
x-azurecdn-request-date 必需。 以 yyyy-MM-dd hh:mm:ss 格式输入当前 UTC 请求时间。
授权 必需。 请参阅 CDN API 签名机制以了解授权标头。
Content-Type 必需。 application/json

请求正文

若要添加缓存刷新，请指定以下参数。 示例 JSON 文件如下：

{
  "Files": [
    "http://example.com/pictures/city.png"
  ],
  "Directories": [
    "http://example.com/pictures/"
  ]
}
参数名称 描述
文件 刷新文件列表时，路径必须是绝对路径。 例如：http://example.com/pictures/city.png
目录 刷新目录列表时，路径必须是绝对路径。 例如：http://example.com/pictures/

响应

响应包括状态代码、响应头和响应正文。

状态代码

状态代码 描述
202 表明服务器已成功接受请求。
其他 指示发生错误的一般响应。

响应标头

响应头 描述
X-Correlation-Id 请求的唯一标识符，用于跟踪请求信息。

响应正文

请求成功的 JSON 示例：

{
  "Succeeded": true,
  "IsAsync": true,
  "AsyncInfo": {
    "TaskTrackId": "b520c544-ec34-4ac4-86f5-5394363919c3",
    "TaskStatus": "Processing"
  }
}
参数名称 描述
TaskTrackId 刷新操作唯一标识，可用于查询刷新进度。
TaskStatus 任务状态
  • NotSet：状态未知
  • Processing：正在处理
  • Succeeded：成功
  • Failed：失败

请求失败的 JSON 示例:

{
  "Succeeded": false,
  "ErrorInfo": {
    "Type": "MissingAuthorizationHeader",
    "Message": "Missing authorization header."
  }
}
参数名称 描述
类型 错误类型
  • CredentialInvalid：凭据无效
  • ParameterMissing：参数缺失
  • ParameterInvalid：参数无效
  • MissingAuthorizationHeader：授权标头缺失
  • InvalidRequestDateHeader：请求日期标头无效
  • MissingRequestDateHeader：请求日期标头缺失
  • AuthorizationHeaderExpired：授权标头过期
  • InvalidAuthorizationHeader：授权标头无效
  • ApiKeyNotFound：找不到 API 密钥
  • InvalidApiKey：API 密钥无效
  • WrongSignature：签名错误
  • SubscriptionNotFound：订阅不存在
  • EndpointDoesNotBelongToSubscription：终结点不属于订阅
  • EndpointNotInActiveState：终结点未处于活跃状态
  • EndpointNotFound：终结点不存在
  • MaliciousItemPathDetected：检测到恶意项路径
  • PermissionDenied：权限不足
  • RequestThrottled：请求中止
消息 错误信息