4.2 域名配置
4.2.10 设置缓存规则
响应示例
状态码: 200 OK
{ "code" : "success",
"result" : "operate success!", "data" : { }
}
状态码
状态码 描述
200 OK
错误码
请参见错误码。
4.2.10 设置缓存规则
功能介绍
设置CDN节点上缓存资源的缓存策略。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1.0/cdn/domains/{domain_id}/cache 表4-97 路径参数
参数 是否必选 参数类型 描述
domain_id 是 String 加速域名ID。获取方法请参见查 询加速域名。
表4-98 Query 参数
参数 是否必选 参数类型 描述
enterprise_pro
ject_id 否 String 当用户开启企业项目功能时,该
参数生效,表示查询资源所属项 目,不传表示查询默认项目。注 意:当使用子账号调用接口时,
该参数必传。
请求参数
表4-99 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取(响应消息头中 X-Subject-Token的值)。
表4-100 请求 Body 参数
参数 是否必选 参数类型 描述
cache_config 是 CacheConfig Request object
缓存配置对象
表4-101 CacheConfigRequest
参数 是否必选 参数类型 描述
ignore_url_par
ameter 否 Boolean 是否忽略url中的参数。
follow_origin 否 Boolean 缓存规则是否遵循源站 compress 否 CompressReq
uest object GZIP压缩
rules 否 Array of
Rules objects 缓存规则,将覆盖之前的规则配 置。规则为空重置为默认规则。
表4-102 CompressRequest
参数 是否必选 参数类型 描述
compress_swit
ch 否 Integer GZIP压缩开关。0关闭。1打开
表4-103 Rules
参数 是否必选 参数类型 描述
rule_type 是 Integer 0:全部类型,表示匹配所有文 件,默认值。 1:文件类型,表 示按文件后缀匹配。 2:文件夹 类型,表示按目录匹配。 3:文 件全路径类型,表示按文件全路 径匹配。
content 否 String 缓存匹配设置。 当rule_type为0 时,为空。 当rule_type为1时,
为文件后缀,输入首字符为
“.”,以“;”进行分隔,
如.jpg;.zip;.exe,并且输入的文 件名后缀总数不超过20个。 当 rule_type为2时,为目录,输入 要求以“/”作为首字符,以
“;”进行分隔,如/test/
folder01;/test/folder02,并且 输入的目录路径总数不超过20 个。 当rule_type为3时,为全路 径,输入要求以“/”作为首字 符,支持匹配指定目录下的具体 文件,或者带通配符“”的文 件,如/test/index.html或/
test/.jpg。
ttl 是 Integer 缓存时间。最大支持365天。
ttl_type 是 Integer 缓存时间单位。1:秒;2:
分;3:小时;4:天。
priority 是 Integer 此条配置的权重值, 默认值1,
数值越大,优先级越高。取值范 围为1-100,权重值不能相同。
响应参数
状态码: 200
表4-104 响应 Body 参数
参数 参数类型 描述
cache_config CacheConfig
object 缓存配置对象
表4-105 CacheConfig
参数 参数类型 描述
ignore_url_par
ameter Boolean 是否忽略url中的参数。
follow_origin Boolean 缓存规则是否遵循源站 compress CompressRes
ponse object GZIP压缩 rules Array of
Rules objects 缓存规则,将覆盖之前的规则配置。规则为空重 置为默认规则。
表4-106 CompressResponse
参数 参数类型 描述
compress_swit
ch Integer GZIP压缩开关。0关闭。1打开 compress_rule
s Array of CompressRul es objects
GZIP压缩规则
表4-107 CompressRules
参数 参数类型 描述
compress_typ
e String GZIP压缩类型(目前只支持 gzip)
compress_file
_type String GZIP压缩文件类型(文件后缀竖线分割,
如:.js|.html|.css|.xml)
表4-108 Rules
参数 参数类型 描述
rule_type Integer 0:全部类型,表示匹配所有文件,默认值。 1:
文件类型,表示按文件后缀匹配。 2:文件夹类 型,表示按目录匹配。 3:文件全路径类型,表 示按文件全路径匹配。
content String 缓存匹配设置。 当rule_type为0时,为空。 当 rule_type为1时,为文件后缀,输入首字符为
“.”,以“;”进行分隔,如.jpg;.zip;.exe,并且 输入的文件名后缀总数不超过20个。 当rule_type 为2时,为目录,输入要求以“/”作为首字符,
以“;”进行分隔,如/test/folder01;/test/
folder02,并且输入的目录路径总数不超过20 个。 当rule_type为3时,为全路径,输入要求以
“/”作为首字符,支持匹配指定目录下的具体文 件,或者带通配符“”的文件,如/test/
index.html或/test/.jpg。
ttl Integer 缓存时间。最大支持365天。
ttl_type Integer 缓存时间单位。1:秒;2:分;3:小时;4:
天。
priority Integer 此条配置的权重值, 默认值1,数值越大,优先级 越高。取值范围为1-100,权重值不能相同。
请求示例
PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff808***********************2d71/cache?
enterprise_project_id=0 { "cache_config" : {
"ignore_url_parameter" : false, "follow_origin" : false, "compress" : {
"rules" : [ { "rule_type" : 1, "content" : ".jpg;.png", "ttl" : 30,
"ttl_type" : 3, "priority" : 1 }, {
"rule_type" : 0, "content" : "", "ttl" : 600, "ttl_type" : 1, "priority" : 1 } ],
"ignore_url_parameter" : false, "follow_origin" : false, "compress" : {
"compress_switch" : 1, "compress_rules" : [ { "compress_type" : "gzip",
"compress_file_type" : ".js|.html|.css|.xml|.json|.shtml|.htm"
} ] } }}
状态码
状态码 描述
200 OK
错误码
请参见错误码。