You need to enable JavaScript to run this app.
文档中心
内容分发网络

内容分发网络

复制全文
下载 pdf
配置操作接口
BatchUpdateCdnConfig - 批量修改加速域名配置
复制全文
下载 pdf
BatchUpdateCdnConfig - 批量修改加速域名配置

批量更新多个加速域名的配置。

说明

您无法更新 Status 是 offline 的域名。要获取一个域名的状态,请调用 DescribeCdnConfig。

使用限制

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

请求说明

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

公共参数

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

Body

基础配置

域名配置

参数名称
数据类型
是否必选
参数说明
示例
Domains
String[]
是
表示待更新的域名列表,最多包含 50 个域名。
["abc.example.com","zzz.example.com"]
Aggregate
Boolean
否

该参数的作用如下:

  • 决定是否在 API 的响应中展示每个域名的配置更新结果。
  • 当 CDN 无法更新 Domains 列表中某个域名的配置时,CDN 的行为。

该参数有以下取值:

  • true:表示 API 的响应中不展示每个域名的配置更新结果。另外,如果 CDN 无法更新一个域名的配置,该 API 会放弃更新所有域名的配置,并且响应正文会包含 Error 结构体。该结构体中包含的是配置更新失败的域名的错误信息。参见示例 1。
  • false:表示 API 的响应中展示每个域名的配置更新结果。响应正文会包含 DeployResult 结构体。该结构体包含的是每个域名的配置更新结果。参见示例 2。另外,如果 CDN 无法更新一个域名的配置,CDN 会继续更新其他域名的配置。
该参数的默认值是 true。
true

IPv6 加速

参数名称
数据类型
是否必选
参数说明
示例
IPv6
Object
否
表示 IPv6 配置。

源站配置

参数名称
数据类型
是否必选
参数说明
示例
Origin
Object[]
否
表示源站配置。

条件源站

参数名称
数据类型
是否必选
参数说明
示例
ConditionalOrigin
Object
否
表示 "条件源站" 特性的配置。要使用此特性,请 提交工单。

回源协议

参数名称
数据类型
是否必选
参数说明
示例
OriginProtocol
String
是

表示回源请求使用的协议。该参数有以下取值:

  • http:表示回源请求使用 HTTP 协议。

  • https:表示回源请求使用 HTTPS 协议。

  • followclient:表示回源协议与用户请求使用的协议相同。

http

源站证书校验

参数名称
数据类型
是否必选
参数说明
示例
OriginCertCheck
Object
否

表示 "源站证书校验" 特性的配置。要使用此特性,请 提交工单。

该特性启用后,CDN 会校验源站证书的合法性,包括证书是否已被吊销、证书是否由可信 CA 签发、证书与源站域名是否匹配等。CDN 内置了常见可信 CA 的根证书。

该特性还支持双向认证,使源站对 CDN 身份进行校验。您需要在 CDN 中指定相应的客户端证书。

IPv6 回源

参数名称
数据类型
是否必选
参数说明
示例
OriginIPv6
String
否

表示 "IPv6 回源" 的配置。该参数有以下取值:

  • ipv6_first:表示 CDN 始终尝试获取源站域名的 IPv6 地址。如果无法获取该 IP 地址,CDN 才尝试获取源站域名的 IPv4 地址。

  • ipv4_first:表示 CDN 始终尝试获取源站域名的 IPv4 地址。如果无法获取该 IP 地址,CDN 才尝试获取源站域名的 IPv6 地址。

  • followclient:表示 CDN 尝试获取与用户请求相同类型的 IP 地址。

该参数的默认值是 followclient。

由于海外部分 CDN 回源节点不支持向 IPv6 地址发送回源请求,该功能仅适用于位于中国内地的回源节点。
followclient

回源 Host

参数名称
数据类型
是否必选
参数说明
示例
OriginHost
String
否

如果源站服务器上有多个站点,该参数表示回源请求访问的站点域名。该参数对所有源站配置生效,但是优先级低于源站配置中 OriginHost 参数。

该参数的默认值与 Domain 相同。

如果源站是一个对象存储桶,您无需指定该参数。其默认值与源站配置中的 Address 相同。
img.example.com

HTTPS 配置

HTTPS

参数名称
数据类型
是否必选
参数说明
示例
HTTPS
Object
否
表示 HTTPS 特性的配置。

HTTPS 强制跳转到 HTTP 设置

参数名称
数据类型
是否必选
参数说明
示例
HttpForcedRedirect
Object
否

表示 "HTTPS 强制跳转到 HTTP" 特性的配置。

说明

关于 HTTP 重定向至 HTTPS 的配置,参见 HTTPS 下的 ForcedRedirect 特性。HttpForcedRedirect 与 ForcedRedirect 是互斥的。也就是说,如果您配置了其中任意一个特性,就不能配置另一个。

QUIC 设置

参数名称
数据类型
是否必选
参数说明
示例
Quic
Object
否
表示 QUIC 配置。

访问控制

URL 标准化

参数名称
数据类型
是否必选
参数说明
示例
UrlNormalize
Object
否
表示 "URL 标准化" 特性的配置。

地域访问控制

参数名称
数据类型
是否必选
参数说明
示例
AreaAccessRule
Object
否
表示 "地域访问控制" 特性的配置。

禁用 HTTP Method

参数名称
数据类型
是否必选
参数说明
示例
MethodDeniedRule
Object
否
表示 "禁用 HTTP Method" 特性的配置。

IP 黑白名单

参数名称
数据类型
是否必选
参数说明
示例
IpAccessRule
Object
否

表示 "IP 黑白名单" 特性的配置。

该特性提供了两种配置方式:

  • 常规配置:指定 RuleType 和 Ip 对当前加速域名进行配置。
  • 全局配置:指定 SharedConfig 使用一个全局配置。全局配置是白名单功能。要使用此功能,请 提交工单。
您只能选择一种配置方式。

Referer 黑白名单

参数名称
数据类型
是否必选
参数说明
示例
RefererAccessRule
Object
否
表示 "Referer 黑白名单" 特性的配置。关于不同配置对请求匹配结果的影响,参见 配置示例。

UA 黑白名单

参数名称
数据类型
是否必选
参数说明
示例
UaAccessRule
Object
否
表示 "UA 黑白名单" 特性的配置。

Origin 黑白名单

参数名称
数据类型
是否必选
参数说明
示例
OriginAccessRule
Object
否
表示 "Origin 黑白名单" 特性的配置。

自定义头部黑白名单

参数名称
数据类型
是否必选
参数说明
示例
CustomizeAccessRule
Object
否
表示 "自定义头部黑白名单" 特性的配置。要使用该特性,请 提交工单。

自定义拦截规则

参数名称
数据类型
是否必选
参数说明
示例
RequestBlockRule
Object
否
表示 "自定义拦截" 特性的配置。

URL 重定向改写

参数名称
数据类型
是否必选
参数说明
示例
RedirectionRewrite
Object
否
表示 "URL 重定向改写" 特性的配置。

URL 鉴权

参数名称
数据类型
是否必选
参数说明
示例
SignedUrlAuth
Object
否
表示 "URL 鉴权" 特性的配置。

远程鉴权

参数名称
数据类型
是否必选
参数说明
示例
RemoteAuth
Object
否
表示 "远程鉴权" 特性的配置。

下载限速

参数名称
数据类型
是否必选
参数说明
示例
DownloadSpeedLimit
Object
否
表示 "下载限速" 特性的配置。

缓存配置

缓存键值

参数名称
数据类型
是否必选
参数说明
示例
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": "/"
            }
        ]
    }
}

节点缓存规则

参数名称
数据类型
是否必选
参数说明
示例
Cache
Object[]
否

表示 "缓存规则" 特性的配置。该特性默认为禁用,表示不创建自定义规则。

  • 列表中最多可以包含 50 条规则。
  • 列表中规则的顺序定义了规则的优先级。列表中第一条规则的优先级最高。
  • 当收到一个用户请求时,CDN 按规则的优先级,从高到低将规则与请求匹配。如果一条规则匹配了请求,CDN 就停止处理其余规则。
CDN 中有一条 默认缓存规则,用于匹配任何未能匹配其他规则的用户请求。该默认规则始终生效,并且优先级最低。您无需在配置该特性时指定该默认规则。

状态码缓存规则

参数名称
数据类型
是否必选
参数说明
示例
NegativeCache
Object[]
否

表示 "状态码缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:

  • 每条规则包含匹配条件配置和操作配置。
  • 列表中最多可以包含 50 条规则。
  • 规则在列表中出现的顺序表示规则的优先级。列表中第一条规则的优先级最高。
  • 当收到一个用户请求时,CDN 按规则的优先级,从高到低将规则与请求匹配。如果一条规则匹配了请求,CDN 就停止处理其余规则。

浏览器缓存规则

参数名称
数据类型
是否必选
参数说明
示例
BrowserCache
Object[]
否

表示 "浏览器缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:

  • 每条规则包含匹配条件配置和操作配置。
  • 列表中最多可以包含 50 条规则。
  • 规则在列表中出现的顺序表示规则的优先级。列表中第一条规则的优先级最高。
  • 当收到一个用户请求时,CDN 按规则的优先级,从高到低将规则与请求匹配。如果一条规则匹配了请求,CDN 就停止处理其余规则。

HTTP 响应头设置

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

自定义错误页面

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

共享缓存

参数名称
数据类型
是否必选
参数说明
示例
CacheHost
Object
否

表示 "共享缓存" 特性的配置。要使用该功能,请 提交工单。

如果您要对多个加速域名配置共享缓存,您需要调用该 API 对每个加速域名配置目标域名。

Multi-range

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

离线缓存

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

回源配置

Range 回源设置

参数名称
数据类型
是否必选
参数说明
示例
OriginRange
Boolean
否

表示 "回源 Range" 特性的配置。该参数有以下取值:

  • true:表示启用该特性。
  • false:表示禁用该特性。

该参数的默认值是 false。请求分片大小默认是 1 MB。

说明

如果 Range 结构体中 Switch 为 true,则该特性为启用,即使 OriginRange 为 false。

true
Range
Object
否
表示分片大小的设置。

回源超时时间设置

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

回源重试设置

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

回源重定向跟随

参数名称
数据类型
是否必选
参数说明
示例
FollowRedirect
Boolean
否

表示 "回源重定向跟随" 特性的配置。该参数有以下取值:

  • true:表示启用该特性。
  • false:表示禁用该特性。
该参数的默认值是 false。
true

回源 HTTP 请求头设置

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

回源 URL 改写

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

回源参数设置

参数名称
数据类型
是否必选
参数说明
示例
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": "*"
            }
        ]
    }
}

说明

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

  • 规则列表中只能包含上述这条默认规则。
  • 在这条默认规则的 OriginArgAction 中,Action 的值只能为 include 或者 exclude。

回源 SNI 设置

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

源站响应头设置

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

内容优化

智能压缩

参数名称
数据类型
是否必选
参数说明
示例
Compression
Object
否
表示 "智能压缩" 特性的配置。

页面优化

参数名称
数据类型
是否必选
参数说明
示例
PageOptimization
Object
否
表示 "页面优化" 特性的配置。

视频拖拽

参数名称
数据类型
是否必选
参数说明
示例
VideoDrag
Object
否
表示 "视频拖拽" 特性的配置。

标准 HLS 加密改写

参数名称
数据类型
是否必选
参数说明
示例
RewriteHLS
Object
否
表示 "标准 HLS 加密改写" 特性的配置。要使用该功能,请 提交工单。

规则引擎

参数名称
数据类型
是否必选
参数说明
示例
RuleEngine
Object
否
详情参见 规则引擎配置。

返回参数

参数名称
数据类型
参数说明
示例
DeployResult
Object[]
表示 Domains 列表中各域名的配置更新结果。该参数仅当 Aggregate 是 false 时才会出现。

请求示例 1

该示例主要展示 Aggregate 为 true 时的响应示例。关于其他配置的请求示例,参见 UpdateCdnConfig。

POST https://cdn.volcengineapi.com/?Action=BatchUpdateCdnConfig&Version=2021-03-01
{
    "Domains": [
        "www.example.com",
        "img.example.com",
        "videos.example.com"
    ],
    "OriginProtocol": "http",
    "HTTPS": {
        "Switch": true,
        "OCSP": true
    },
    "Aggregate": true
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "202410091237542EE1A0C61B73114E0B08",
        "Action": "BatchUpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01",
        "Error": {
            "Code": "InvalidParameter.Domain.Locked",
            "Message": "域名处于代运维状态,无法自助修改配置。"
        }
    }
}

请求示例 2

该示例主要展示 Aggregate 为 false 时的响应示例。关于其他配置的请求示例,参见 UpdateCdnConfig。

POST https://cdn.volcengineapi.com/?Action=BatchUpdateCdnConfig&Version=2021-03-01
{
    "Domains": [
        "www.example.com",
        "img.example.com",
        "videos.example.com"
    ],
    "OriginProtocol": "http",
    "HTTPS": {
        "Switch": true,
        "OCSP": true
    },
    "Aggregate": false
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20241009141640E5DE873D9A01D9F72861",
        "Action": "BatchUpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "DeployResult": [
            {
                "Domain": "www.example.com",
                "Status": "success"
            },
            {
                "Domain": "img.example.com",
                "ErrorMsg": "域名处于代运维状态,无法自助修改配置。",
                "Status": "fail"
            },
            {
                "Domain": "videos.example.com",
                "ErrorMsg": "传入的HTTPS.CertInfo字段不允许为空。",
                "Status": "fail"
            }
        ]
    }
}

错误码

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

最近更新时间:2026.10.21 13:59:41
这个页面对您有帮助吗?
有用
有用
无用
无用