缓存规则配置

可以使用该 API 为目录、文件名和完整路径配置缓存规则。

• 基于目录的配置：目录必须以正斜杠“/”开头（例如 /pic、/doc 或 /htdoc/data）。 后端会匹配指定目录中的所有文件，包括子目录。

• 基于文件扩展名的配置：常见的文件扩展名，如 .jpg、.png、.gif、.txt、.m4v 或 .mp3。 后端会匹配所有文件夹中指定的文件后缀。

• 基于路径的完整配置：用来指定单个文件，必须以“/”开头。比如：“/sites/doc/example.doc”。 如果输入的路径是“/”，则匹配主页。

  注意

  配置规则时，输入的字符串不得包含“{”、“}”、“(”、“)”、“[”、“]”、“.”、“?”、“*”、“ ”、“^”、“$”等特殊字符。

  时间值为 0 表示禁止缓存，不缓存规则优先执行。  

请求

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

URI 参数

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

请求头

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

请求正文

{
  "Rules": [
    {
      "Type": "Dir",
      "Items": [
        "/test1/",
        "/test2/"
      ],
      "TTL": 86400
    },
    {
      "Type": "Suffix",
      "Items": [
        "7z",
        "apk",
        "wdf",
        "cab"
      ],
      "TTL": 2592000
    },
    {
      "Type": "FullUri",
      "Items": [
        "/test1/test.xml",
        "/test2/test.txt"
      ],
      "TTL": 86400
    },
  ],
  "IgnoreCacheControl": false,
  "IgnoreCookie": false,
  "IgnoreQueryString": false
}

参数名称	描述
TTL	缓存时间（以秒为单位）。
IgnoreCacheControl	指示是否忽略所返回标头中的 cache-control 标头并缓存请求内容。
IgnoreCookie	指示是否忽略所返回标头中的 set-cookie 标头并缓存请求内容。
IgnoreQueryString	指示是否忽略查询参数并缓存请求内容。
类型	缓存规则类型 Suffix：根据文件扩展名进行缓存 Dir：缓存指定目录中的所有文件 FullUri：缓存特定路径上的文件

响应

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

状态代码

状态代码	描述
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：请求中止
消息	错误信息