回源配置--内容分发网络-火山引擎

文档中心

立即注册

内容分发网络

UpdateCdnConfig - 修改加速域名配置

回源配置

API 说明

API 名称：UpdateCdnConfig。
API 域名：cdn.volcengineapi.com。
API 描述：修改加速域名的配置。

注意

该 API 对加速域名的配置模块进行覆盖式修改，说明如下：

在您创建一个 API 请求时，如果未指定某个模块，在您提交 API 请求后，该模块的已有配置不会发生改变。
如果您指定了某个模块，但没有指定该模块下的某个可选参数，则该参数会使用默认值。在您提交 API 请求后，该参数的已有值就会被默认值覆盖。

使用限制

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

请求说明

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

公共参数

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

请求正文参数

Range 回源设置

参数名称	数据类型	是否必选	参数说明	示例
OriginRange	Boolean	否	表示 "回源 Range" 特性的配置。该参数有以下取值： `true`：表示启用该特性。 `false`：表示禁用该特性。该参数的默认值是 `false`。请求分片大小默认是 1 MB。说明如果 `Range` 结构体中 `Switch` 为 `true`，则该特性为启用，即使 `OriginRange` 为 `false`。	`true`
Range	Object	否	表示分片大小的设置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginRange": true,
    "Range": {
        "Switch": true,
        "RangeSize": "2",
        "Unit": "MB"
    }
}

回源超时时间设置

参数名称	数据类型	是否必选	参数说明	示例
Timeout	Object	否	表示 "回源超时时间" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Timeout": {
        "Switch": true,
        "TimeoutRules": [
            {
                "TimeoutAction": {
                    "TcpTimeout": 2,
                    "HttpTimeout": 60
                }
            }
        ]
    }
}

回源重试设置

参数名称	数据类型	是否必选	参数说明	示例
OriginRetry	Object	否	表示 "回源重试设置" 特性的配置。要使用该功能，请提交工单。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginRetry": {
        "Switch": true,
        "StatusCode": "404;408;5xx"
    }
}

回源重定向跟随

参数名称	数据类型	是否必选	参数说明	示例
FollowRedirect	Boolean	否	表示 "回源重定向跟随" 特性的配置。该参数有以下取值： `true`：表示启用该特性。 `false`：表示禁用该特性。该参数的默认值是 `false`。	`true`

请求示例

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

回源 HTTP 请求头设置

参数名称	数据类型	是否必选	参数说明	示例
RequestHeader	Object[]	否	表示 "回源 HTTP 请求头" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "RequestHeader": [
        {
            "RequestHeaderAction": {
                "RequestHeaderInstances": [
                    {
                        "Action": "set",
                        "Key": "cdn-servce",
                        "Value": "volcengine",
                        "ValueType": "constant"
                    }
                ]
            }
        }
    ]
}

回源 URL 改写

参数名称	数据类型	是否必选	参数说明	示例
OriginRewrite	Object	否	表示 "回源 URL 改写" 特性的配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginRewrite": {
        "OriginRewriteRule": [
            {
                "OriginRewriteAction": {
                    "RewriteType": "rewrite_url",
                    "SourcePath": "^/aaa/(.*),txt\?param=(.*)",   // 在 `DescribeCdnConfig` 的响应中，由于 JSON 格式要求，该参数值中的 `\?` 会展示为 `\\?`。
                    "TargetPath": "/life/$1?size=$2"
                }
            },
            {
                "OriginRewriteAction": {
                    "RewriteType": "rewrite_path",
                    "SourcePath": "^/a(1,2)(.*)g$",
                    "TargetPath": "/food/$1"
                }
            }
        ],
        "Switch": true
    }
}

回源参数设置

要使用本特性中所有参数，您加速域名的源站配置必须已升级到新版本。参见新版源站配置介绍。

如果您加速域名的源站配置尚未升级到新版本，回源参数的配置会有以下限制：

您只能添加 OriginArg 参数说明中描述的预设规则。
在这条预设规则的 OriginArgAction 中，您只能设置 Action 为 include 或者 exclude。

参数名称	数据类型	是否必选	参数说明	示例
OriginArg	Object[]	否	表示 "回源参数" 配置的规则列表。列表中最多可以包含 50 条规则。每条规则包含一个匹配条件（`Condition`）和 CDN 执行操作（`OriginArgAction`）。列表中规则的顺序定义了规则的优先级。列表中第一条规则的优先级最高。当收到一个用户请求时，CDN 按规则的优先级，从高到低将规则与请求匹配。如果一条规则匹配了请求，CDN 就停止处理其余规则。您必须在规则列表的最后添加以下这条默认规则。该默认规则用于匹配任何未能匹配其他规则的用户请求。您不可更改该规则中的 `Condition`，但可以更改 `OriginArgAction` 中的配置。 `{ "Condition": { "ConditionRule": [ { "Object": "directory", "Operator": "match", "Type": "url", "Value": "/" } ] }, "OriginArgAction": { "OriginArgComponents": [ { "Action": "include", "Object": "queryString", "Subobject": "*" } ] } }`

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginArg": [
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/dir4/path6/"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "set",
                        "Object": "queryString",
                        "Subobject": "param6=val6;param7=val7"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "filetype",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "docx"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "excludePart",
                        "Object": "queryString",
                        "Subobject": "param5"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "regex",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "^/a{1,2}(.*)g$;aaa(.*)"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "includePart",
                        "Object": "queryString",
                        "Subobject": "param3;param4"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "filetype",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "png;jpg"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "addPart",
                        "Object": "queryString",
                        "Subobject": "param1=val1;param2=val2"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "path",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/dir1/file;/dir2/image.jpg"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "include",
                        "Object": "queryString",
                        "Subobject": "*"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/dir1/path1/;/dir2/path2/"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "exclude",
                        "Object": "queryString",
                        "Subobject": "*"
                    }
                ]
            }
        },
        {
            "Condition": {
                "ConditionRule": [
                    {
                        "Object": "directory",
                        "Operator": "match",
                        "Type": "url",
                        "Value": "/"
                    }
                ]
            },
            "OriginArgAction": {
                "OriginArgComponents": [
                    {
                        "Action": "include",
                        "Object": "queryString",
                        "Subobject": "*"
                    }
                ]
            }
        }
    ]
}

回源 SNI 设置

参数名称	数据类型	是否必选	参数说明	示例
OriginSni	Object	否	表示 "回源 SNI" 特性的配置。

请求示例

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

源站响应头设置

参数名称	数据类型	是否必选	参数说明	示例
OriginResponseHeader	Object[]	否	表示 "源站响应头设置" 的配置。要使用该特性，请提交工单。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginResponseHeader": [
        {
            "OriginResponseHeaderAction": {
                "OriginResponseHeaderInstances": [
                    {
                        "Action": "delete",
                        "Key": "Access-Control-Allow-Credentials"
                    },
                    {
                        "Action": "set",
                        "Key": "Access-Control-Allow-Headers",
                        "ValueType": "customize",
                        "Object": "default",
                        "Value": "Notice${query_string}!"
                    },
                    {
                        "Action": "set",
                        "Key": "Access-Control-Allow-Methods",
                        "ValueType": "variable",
                        "Object": "all_request",
                        "Value": "request_uri"
                    },
                    {
                        "Action": "set",
                        "Key": "myHeader2",
                        "ValueType": "constant",
                        "Value": "HelloWorld",
                        "Object": "default"
                    }
                ]
            }
        }
    ]
}

返回参数

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

返回示例

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

错误码

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

最近更新时间：2025.12.19 16:49:08

这个页面对您有帮助吗？

有用

无用