缓存配置--内容分发网络-火山引擎

文档中心

立即注册

内容分发网络

UpdateCdnConfig - 修改加速域名配置

缓存配置

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=UpdateCdnConfig&Version=2021-03-01

公共参数

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `UpdateCdnConfig`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

请求正文参数

缓存键值

参数名称	数据类型	是否必选	参数说明	示例
CacheKey	Object[]	否	表示 "缓存键值" 特性的配置。在该配置中，您可以创建一个规则列表，说明如下：每条规则包含匹配条件配置和操作配置。列表中最多可以包含 50 条规则。规则在列表中出现的顺序表示规则的优先级。列表中第一条规则的优先级最高。当收到一个用户请求时，CDN 按规则的优先级，从高到低将规则与请求匹配。如果一条规则匹配了请求，CDN 就停止处理其余规则。您必须在列表中添加以下默认规则，并且这条规则必须出现在列表的末尾。该默认规则用于匹配任何未能匹配其他规则的用户请求。在默认规则中，您可以调整 `CacheKeyAction` 的配置，但不能调整 `Condition` 的配置。 `{ "CacheKeyAction": { "CacheKeyComponents": [ { "Action": "include", "IgnoreCase": true, "Object": "queryString", "Subobject": "*" } ] }, "Condition": { "ConditionRule": [ { "Name": "", "Object": "directory", "Operator": "match", "Type": "url", "Value": "/" } ] } }`

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "CacheKey": [
        {
            "CacheKeyAction": {
                "CacheKeyComponents": [
                    {
                        "Action": "excludePart",
                        "IgnoreCase": true,
                        "Object": "queryString",
                        "Subobject": "version"
                    }
                ]
            },
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "path",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/www/img/volcano.png",
                        "IgnoreCase": true
                    }
                ]
            }
        },
        {
            "CacheKeyAction": {
                "CacheKeyComponents": [
                    {
                        "Action": "include",
                        "IgnoreCase": true,
                        "Object": "queryString",
                        "Subobject": "*"
                    }
                ]
            },
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/"
                    }
                ]
            }
        }
    ]
}

节点缓存规则

参数名称	数据类型	是否必选	参数说明	示例
Cache	Object[]	否	表示 "缓存规则" 特性的配置。该特性默认为禁用，表示不创建自定义规则。列表中最多可以包含 50 条规则。列表中规则的顺序定义了规则的优先级。列表中第一条规则的优先级最高。当收到一个用户请求时，CDN 按规则的优先级，从高到低将规则与请求匹配。如果一条规则匹配了请求，CDN 就停止处理其余规则。 CDN 中有一条默认缓存规则，，用于匹配任何未能匹配其他规则的用户请求。该默认规则始终生效，并且优先级最低。您无需在配置该特性时指定该默认规则。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Cache": [
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "filetype",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "png;js"
                    }
                ]
            },
            "CacheAction": {
                "Action": "cache",
                "IgnoreCase": true,
                "Ttl": 1000
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/test/dir/"
                    }
                ]
            },
            "CacheAction": {
                "Action": "cache",
                "Ttl": 2000
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/"
                    }
                ]
            },
            "CacheAction": {
                "Action": "cache",
                "Ttl": 2000,
                "DefaultPolicy": "force_cache"
            }
        }
    ]
}

状态码缓存规则

参数名称	数据类型	是否必选	参数说明	示例
NegativeCache	Object[]	否	表示 "状态码缓存" 特性的配置。在该配置中，您可以创建一个规则列表，说明如下：每条规则包含过匹配条件配置和操作配置。列表中最多可以包含 50 条规则。规则在列表中出现的顺序表示规则的优先级。列表中第一条规则的优先级最高。当收到一个用户请求时，CDN 按规则的优先级，从高到低将规则与请求匹配。如果一条规则匹配了请求，CDN 就停止处理其余规则。

请求示例

在这个示例中，第二个 NegativeCache 的规则不生效。状态码 405 的实际 Ttl 是 1000。

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain":"www.example.com",
    "NegativeCache": [
        {
            "Condition":{
                "ConditionRule":[
                    {
                        "Object":"filetype",
                        "Operator":"match",
                        "Type":"url",
                        "Value":"png;js"
                    }
                ]
            },
            "NegativeCacheRule": {
                "Action":"cache",
                "StatusCode":"4xx",
                "Ttl":1000
            }
        },
        {
            "Condition":{
                "ConditionRule":[
                    {
                        "Object":"filetype",
                        "Operator":"match",
                        "Type":"url",
                        "Value":"png;js"
                    }
                ]
            },
            "NegativeCacheRule":{
                "Action":"cache",
                "StatusCode":"405",
                "Ttl":2000
            }
        }
    ]
}

浏览器缓存规则

参数名称	数据类型	是否必选	参数说明	示例
BrowserCache	Object[]	否	表示 "浏览器缓存" 特性的配置。在该配置中，您可以创建一个规则列表，说明如下：每条规则包含匹配条件配置和操作配置。列表中最多可以包含 50 条规则。规则在列表中出现的顺序表示规则的优先级。列表中第一条规则的优先级最高。当收到一个用户请求时，CDN 按规则的优先级，从高到低将规则与请求匹配。如果一条规则匹配了请求，CDN 就停止处理其余规则。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "BrowserCache": [
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "filetype",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "png;js"
                    }
                ]
            },
            "CacheAction": {
                "Action": "cache",
                "IgnoreCase": true,
                "Ttl": 1000,
                "DefaultPolicy": "cache"
            }
        }
    ]
}

HTTP 响应头设置

参数名称	数据类型	是否必选	参数说明	示例
ResponseHeader	Object[]	否	表示 "HTTP 响应头" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "ResponseHeader": [
        {
            "ResponseHeaderAction": {
                "ResponseHeaderInstances": [
                    {
                        "Action": "set",
                        "Key": "Content-Disposition",
                        "Value": "attachment;filename=FileName.xls",
                        "ValueType": "constant"
                    },
                    {
                        "Action": "set",
                        "Key": "Access-Control-Allow-Origin",
                        "Value": "https://www.test.com",
                        "AccessOriginControl": true,
                        "ValueType": "constant"
                    }
                ]
            }
        }
    ]
}

自定义错误页面

参数名称	数据类型	是否必选	参数说明	示例
CustomErrorPage	Object	否	表示 "自定义错误页面" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "CustomErrorPage": {
        "Switch": true,
        "ErrorPageRule": [
            {
                "Condition": {},
                "ErrorPageAction": {
                    "StatusCode": "4xx",
                    "Action": "redirect",
                    "RedirectCode": "301",
                    "RedirectUrl": "http://www.test.com/friendlyurl.html"
                }
            }
        ]
    }
}

共享缓存

参数名称	数据类型	是否必选	参数说明	示例
CacheHost	Object	否	表示 "共享缓存" 特性的配置。要使用该功能，请提交工单。如果您要对多个加速域名配置共享缓存，您需要调用该 API 对每个加速域名配置目标域名。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "CacheHost": {
        "Switch": true,
        "CacheHostRule": [
            {
                "CacheHostAction": {
                    "CacheHost": "www.test.com"
                }
            }
        ]
    }
}

Multi-range

参数名称	数据类型	是否必选	参数说明	示例
MultiRange	Object	否	表示 "多重范围（Multi-range)" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "MultiRange": {
        "Switch": true
    }
}

离线缓存

参数名称	数据类型	是否必选	参数说明	示例
OfflineCache	Object	否	表示 "离线缓存" 特性的配置。要使用此特性，请提交工单。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OfflineCache": {
        "Switch": true,
        "Object": "request_error,error_code",
        "StatusCode": "500;504"
    }
}

返回参数

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022010415564801021219713102003D3F",
        "Action": "UpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。

最近更新时间：2026.02.02 10:27:36

这个页面对您有帮助吗？

有用

无用

内容分发网络

使用限制 #

请求说明 #

公共参数 #

请求正文参数 #

缓存键值 #

请求示例

节点缓存规则 #

请求示例

状态码缓存规则 #

请求示例

浏览器缓存规则 #

请求示例

HTTP 响应头设置 #

请求示例

自定义错误页面 #

请求示例

共享缓存 #

请求示例

Multi-range #

请求示例

离线缓存 #

请求示例

返回参数 #

返回示例 #

错误码 #

使用限制

请求说明

公共参数

请求正文参数

缓存键值

节点缓存规则

状态码缓存规则

浏览器缓存规则

HTTP 响应头设置

自定义错误页面

共享缓存

Multi-range

离线缓存

返回参数

返回示例

错误码