请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	指定变更的域名	`www.test.com`
ResourceTags	Object[]	否	绑定在该域名上的资源标签（Tag）信息。
ServiceType	String	否	该加速域名关联的加速场景，取值： `ai`：AI 加速 `upload`：上传加速 `page`：页面加速 `api`：API 加速 `other`：其他	`api`
Scope	String	否	加速区域。取值： `domestic`（默认值）：中国大陆。 `overseas`：中国大陆以外区域。 `global`：全球。	`domestic`
StrategyType	String	否	回源策略，源站类型为 TOS 时，不支持修改。取值： `wrr`：加权轮询。源站类型为 TOS 时，回源策略默认为 `wrr`，不支持配置。 `optimum`：根据源服务器健康度选择最优的源站服务器。	`wrr`
EnableFailOver	Boolean	否	是否开启主备容灾功能，默认不开启，源站类型为 TOS 时，不支持开启。取值： `true`：开启。 `false`：不开启。	`false`
Origin	Object	否	源站配置。
Https	Object	否	HTTPS 访问配置。
Cache	Object	否	缓存配置。
UrlRedirect	Object	否	URL 重写相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时，您可以进行 URL 重定向。
IpAccess	Object	否	基于客户端源 IP 地址的访问黑/白名单。为了解决来自某些特定 IP 的恶意盗刷、攻击等问题，需要对访问来源进行限制，您可以配置 IP 黑白名单。
UserAgentAccess	Object	否	基于客户端 User-Agent 请求头的访问黑/白名单。如果您希望基于用户请求中的 User-Agent 请求头进行规则判断，从而基于客户端类型进行过滤，您可以配置 User-Agent 黑白名单。
RefererAccess	Object	否	基于 Referer 访问黑/白名单。为了防止网站资源被盗链接，您可以配置 Referer 防盗链。
UrlAccess	Object	否	URL 鉴权配置。为了保护站点资源，避免资源被恶意下载盗用，您还可以通过配置 URL 鉴权，达到防止资源被非法下载盗用、提升内容安全性的目的。
GzipCompress	Object	否	Gzip 压缩配置。开启 Gzip 压缩后，全站加速在返回内容时会对资源进行 Gzip 压缩，缩减静态内容尺寸，从而缩短传输时间。
BrCompress	Object	否	Brotli 压缩配置。开启 Brotli 压缩后，全站加速在返回内容时会对资源进行 Brotli，缩减静态内容尺寸，从而缩短传输时间。
StaticOptimization	Object	否	页面性能优化配置。HTTP/2 协议多路复用场景下，通过调整缓冲区策略，控制静态资源请求优先级，实现静态页面加载性能优化。
UploadOptimize	Object	否	上传协议优化配置。开启上传协议优化后，全站加速通过自研协议栈优化策略，提升文件接收和传输性能。
PreConnect	Object	否	预连接配置。开启后预连接后，全站加速主动与源站建立连接，维护连接池，提高回源连接复用率，缩短访问链路耗时。
RTTOptimize	Object	否	回源链路择优配置。开启回源链路择优后，全站加速会选择最优的RTT链路回源，缩短访问链路耗时。只有当预连接开启时，当前选项才可以开启。
IPv6Switch	Boolean	否	是否开启 IPv6 访问功能，默认不开启，取值： `true`：开启。 `false`：不开启。	`false`
WebSocket	Object	否	WebSocket 配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。
PremiumBGPPackage	Object	否	跨境链路优化相关配置.

返回参数

变更域名配置的操作被正确执行时，无返回参数，执行时出错时会返回错误信息。

请求示例 1

同时改动多项源站配置。

POST https://open.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-01-01
{
    "Domain": "dcdn.example.com",
    "Origin": {
        "Origins": [
            {
                "Name": "198.51.100.99",
                "Weight": 100,
                "Type": "IP",
                "Port": 443
            }
        ],
        "OriginType": "IP_Domain",
        "OriginProtocolType": "https",
        "ResponseTimeout": 10,
        "OriginHost": {
            "Enable": true,
            "HostInfo": "alt.example.com"
        },
        "OriginSni": {
            "Enable": false,
            "SniInfo": "alt.example.com"
        },
        "OriginRange": {
            "Enable": true
        },
        "RequestHeader": {
            "Enable": true,
            "HeaderInfo": [
                {
                    "HeaderMode": 0,
                    "HeaderName": "custom-header-1",
                    "HeaderValue": "my-value",
                    "HeaderValueType": "s",
                    "AccessOriginControl": false
                }
            ]
        },
        "FollowRedirect": {
            "Enable": true,
            "MaxTries": 3
        }
    },
    "EnableFailOver": false,
    "StrategyType": "wrr"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateDomainConfig",
        "Version": "2023-01-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    }
}

请求示例 2

改动 WebSocket 超时时间，从原先的 60 改为 30。此时，需要将回源配置 ResponseTimeout 参数也改为 30。

POST https://open.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-01-01
{
    "Domain": "ws.example.com",
    "WebSocket": {
        "Enable": true,
        "Timeout": 30
    },
    "Origin": {
        "ResponseTimeout": 30
    }
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateDomainConfig",
        "Version": "2023-01-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    }
}

错误码

如果接口调用失败并返回错误信息，您可以查看公共错误码了解错误码相关信息。

最近更新时间：2026.08.19 21:09:01

这个页面对您有帮助吗？

有用

无用

全站加速

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 1 #

返回示例 1 #

请求示例 2 #

返回示例 2 #

错误码 #