批量更新多个加速域名的配置。
说明
您无法更新 Status 是 offline 的域名。要获取一个域名的状态,请调用 DescribeCdnConfig。
节流限制:您每秒最多可以提交 20 个 API 请求。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
|---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 BatchUpdateCdnConfig。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Domains | String[] | 是 | 表示待更新的域名列表,最多包含 50 个域名。 | ["abc.example.com","zzz.example.com"] |
Aggregate | Boolean | 否 | 该参数的作用如下:
该参数有以下取值:
true。 | true |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
IPv6 | Object | 否 | 表示 IPv6 配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Origin | Object[] | 否 | 表示源站配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
ConditionalOrigin | Object | 否 | 表示 "条件源站" 特性的配置。要使用此特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginProtocol | String | 是 | 表示回源请求使用的协议。该参数有以下取值:
| http |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginCertCheck | Object | 否 | 表示 "源站证书校验" 特性的配置。要使用此特性,请 提交工单。 该特性启用后,CDN 会校验源站证书的合法性,包括证书是否已被吊销、证书是否由可信 CA 签发、证书与源站域名是否匹配等。CDN 内置了常见可信 CA 的根证书。 该特性还支持双向认证,使源站对 CDN 身份进行校验。您需要在 CDN 中指定相应的客户端证书。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginIPv6 | String | 否 | 表示 "IPv6 回源" 的配置。该参数有以下取值:
该参数的默认值是 | followclient |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginHost | String | 否 | 如果源站服务器上有多个站点,该参数表示回源请求访问的站点域名。该参数对所有源站配置生效,但是优先级低于源站配置中 该参数的默认值与 Address 相同。 | img.example.com |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
HTTPS | Object | 否 | 表示 HTTPS 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
HttpForcedRedirect | Object | 否 | 表示 "HTTPS 强制跳转到 HTTP" 特性的配置。 说明 关于 HTTP 重定向至 HTTPS 的配置,参见 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Quic | Object | 否 | 表示 QUIC 配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
UrlNormalize | Object | 否 | 表示 "URL 标准化" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
AreaAccessRule | Object | 否 | 表示 "地域访问控制" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
MethodDeniedRule | Object | 否 | 表示 "禁用 HTTP Method" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
IpAccessRule | Object | 否 | 表示 "IP 黑白名单" 特性的配置。 该特性提供了两种配置方式:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RefererAccessRule | Object | 否 | 表示 "Referer 黑白名单" 特性的配置。关于不同配置对请求匹配结果的影响,参见 配置示例。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
UaAccessRule | Object | 否 | 表示 "UA 黑白名单" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginAccessRule | Object | 否 | 表示 "Origin 黑白名单" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CustomizeAccessRule | Object | 否 | 表示 "自定义头部黑白名单" 特性的配置。要使用该特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RequestBlockRule | Object | 否 | 表示 "自定义拦截" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RedirectionRewrite | Object | 否 | 表示 "URL 重定向改写" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
SignedUrlAuth | Object | 否 | 表示 "URL 鉴权" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RemoteAuth | Object | 否 | 表示 "远程鉴权" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
DownloadSpeedLimit | Object | 否 | 表示 "下载限速" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CacheKey | Object[] | 否 | 表示 "缓存键值" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
您必须在列表中添加以下默认规则,并且这条规则必须出现在列表的末尾。该默认规则用于匹配任何未能匹配其他规则的用户请求。在默认规则中,您可以调整 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Cache | Object[] | 否 | 表示 "缓存规则" 特性的配置。该特性默认为禁用,表示不创建自定义规则。
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
NegativeCache | Object[] | 否 | 表示 "状态码缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
BrowserCache | Object[] | 否 | 表示 "浏览器缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
ResponseHeader | Object[] | 否 | 表示 "HTTP 响应头" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CustomErrorPage | Object | 否 | 表示 "自定义错误页面" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CacheHost | Object | 否 | 表示 "共享缓存" 特性的配置。要使用该功能,请 提交工单。 如果您要对多个加速域名配置共享缓存,您需要调用该 API 对每个加速域名配置目标域名。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
MultiRange | Object | 否 | 表示 "多重范围(Multi-range)" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OfflineCache | Object | 否 | 表示 "离线缓存" 特性的配置。要使用此特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRange | Boolean | 否 | 表示 "回源 Range" 特性的配置。该参数有以下取值:
该参数的默认值是 说明 如果 | true |
Range | Object | 否 | 表示分片大小的设置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Timeout | Object | 否 | 表示 "回源超时时间" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRetry | Object | 否 | 表示 "回源重试设置" 特性的配置。要使用该功能,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
FollowRedirect | Boolean | 否 | 表示 "回源重定向跟随" 特性的配置。该参数有以下取值:
false。 | true |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RequestHeader | Object[] | 否 | 表示 "回源 HTTP 请求头" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRewrite | Object | 否 | 表示 "回源 URL 改写" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginArg | Object[] | 否 | 表示 "回源参数" 配置的规则列表。
您必须在规则列表的最后添加以下这条默认规则。该默认规则用于匹配任何未能匹配其他规则的用户请求。您不可更改该规则中的
说明 如果您加速域名的源站配置尚未升级到 新版源站配置,回源参数的配置会有以下限制:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginSni | Object | 否 | 表示 "回源 SNI" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginResponseHeader | Object[] | 否 | 表示 "源站响应头设置" 的配置。要使用该特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Compression | Object | 否 | 表示 "智能压缩" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
PageOptimization | Object | 否 | 表示 "页面优化" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
VideoDrag | Object | 否 | 表示 "视频拖拽" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RewriteHLS | Object | 否 | 表示 "标准 HLS 加密改写" 特性的配置。要使用该功能,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RuleEngine | Object | 否 | 详情参见 规则引擎配置。 |
参数名称 | 数据类型 | 参数说明 | 示例 |
|---|---|---|---|
DeployResult | Object[] | 表示 Domains 列表中各域名的配置更新结果。该参数仅当 Aggregate 是 false 时才会出现。 |
该示例主要展示 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 }
{ "ResponseMetadata": { "RequestId": "202410091237542EE1A0C61B73114E0B08", "Action": "BatchUpdateCdnConfig", "Version": "2021-03-01", "Service": "CDN", "Region": "cn-north-01", "Error": { "Code": "InvalidParameter.Domain.Locked", "Message": "域名处于代运维状态,无法自助修改配置。" } } }
该示例主要展示 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 }
{ "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 请求失败。更多关于错误码的信息,参见错误码。