变更域名配置--全站加速-火山引擎

文档中心

立即注册

导航

变更域名配置

最近更新时间：2024.07.04 16:51:49首次发布时间：2023.03.07 10:48:09

API说明

API名称：UpdateDomainConfig 。
API域名：open.volcengineapi.com。
API描述：变更域名配置。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称	是否必选	参数类型	参数说明
Action	是	String	API 名称，该参数的取值是 UpdateDomainConfig 。
Version	是	String	API 版本，该参数的取值是 2023-01-01 。

注意

UpdateDomainConfig 公共参数的 Version为 2023-01-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数名称	是否必选	参数类型	参数说明	示例
Domain	是	String	您可以指定添加的加速域名，具体的添加规则如下：单个账号最多添加50个域名。如需提升单个账号下添加域名数量的上限，请提交工单。中国内地的域名需要完成域名备案后才能添加使用。全站加速支持添加泛域名，泛域名需要以（.）作为首位字符，不能以（*.）作为首位字符且不能以（.）作为末位字符。当前全站加速仅支持二级、三级、四级泛域名。全站加速仅允许单个加速域名添加一次。即单个域名只能添加到您所有开通DCDN服务账号中的一个，不能重复添加。域名字符串以（.）分割，包括末尾（.）在内总长度不超过254个字符。单个字符串由字母、数字、连字符（-）组成，连字符（-）不能出现在字符串的头部或者尾部。单个字符串长度不超过63个字符。	`www.test1.com`
Origin	是	Origin	源站配置。	`-`
StrategyType	是	String	回源策略，源站类型为 TOS 时，不支持修改。支持取值： wrr：加权轮询。 optimum：择优。	`wrr`
Scope	否	String	加速范围，当前仅对白名单用户开放。具体取值如下： domestic（默认值）：中国大陆。 overseas：中国大陆以外区域。 global：全球。	`domestic`
Https	否	Https	Https 加速配置。	`-`
EnableFailOver	否	Boolean	是否开启主备容灾功能，默认不启用，源站类型为TOS时，不支持修改。支持取值： true：启用。 false：不启用。	`false`
IPv6Switch	否	Boolean	是否开启 IPv6 功能，默认不启用，支持取值： true：启用。 false：不启用。	`false`
Cache	否	Cache	缓存配置。	`-`
UrlRedirect	否	UrlRedirect	Url 重写相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时，您可以进行 URL 重写。	`-`
IpAccess	否	IpAccess	Ip 访问黑/白名单。为了解决恶意 IP 盗刷、攻击等问题，需要对访问来源进行限制，您可以在全站加速控制台配置 IP 黑白名单。	`-`
UserAgentAccess	否	UserAgentAccess	UserAgent 访问黑/白名单。如果您希望通过对用户 HTTP 请求头中的 UA 字段进行规则判断，从而进行访问者身份识别及过滤，您可以配置 User-Agent 黑白名单。	`-`
RefererAccess	否	RefererAccess	Referer 访问黑/白名单。为了防止网站资源被盗用，您可以配置 Referer 防盗链。	`-`
UrlAccess	否	UrlAccess	Url 鉴权。为了保护站点资源，避免资源被恶意下载盗用，您还可以通过配置 URL 鉴权，达到防止资源被非法下载盗用、提升内容安全性的目的。	`-`
WebSocket	否	WebSocket	WebSockect 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。	`-`
GzipCompress	否	CmpTypeConf	Gzip压缩。开启Gzip压缩后，全站加速在返回内容时会对资源进行Gzip压缩，减少静态内容大小，节省开销。	`-`
BrCompress	否	CmpTypeConf	Br压缩。开启 Brotli 压缩后，全站加速在返回内容时会对资源进行 Brotli 压缩，减少静态内容大小，节省开销。	`-`
StaticOptimization	否	StaticOptimizationInfo	页面性能优化。H2协议多路复用场景下，通过调整缓冲区策略，控制静态资源请求优先级，实现静态页面加载性能优化。	`-`
BusinessScene	否	String	加速场景，此字段为空时默认为other。具体取值如下： api：API加速场景。 page：页面加速场景。 other（默认值）：其他加速场景。	`other`
PreConnect	否	PreConnect	预连接。开启后预连接后，DCDN服务主动与源站建立连接，维护连接池，提高回源连接复用率，缩短访问链路耗时。	`-`
RTTOptimize	否	RTTOptimize	回源链路择优。开启回源链路择优后，DCDN服务会选择最优的RTT链路回源，缩短访问链路耗时。	`-`

响应正文

域名新增操作被正确执行时，无返回参数，执行时出错时会返回错误信息。

请求示例

POST https://open.volcengineapi.com/?Version=2023-01-01&Action=UpdateDomainConfig&<其他公共请求参数>
    {
        "Domain": "www.test.com",
        "Origin": {
            "Origins": [
                {
                    "Name": "1.1.1.2",
                    "Weight": 1,
                    "Port":12
                }
            ],
            "OriginType": "IP",
            "OriginProtocolType": "http",
            "BackupOriginType": "IP",
            "ResponseTimeout": 10,
            "ResponseHeader": {
                "Enable": false,
                "HeaderInfo": []
            },
            "OriginHost": {
                "Enable": true,
                "HostInfo": "www.test1.com"
            },
            "OriginSni": {
                "Enable": false,
                "SniInfo": ""
            },
            "OriginRange": {
                "Enable": false,
                "Size": ""
            },
            "RequestHeader": {
                "Enable": false,
                "HeaderInfo": []
            },
            "BackupOrigins": []，
            "BackupOriginType": "IP"
        },
        "EnableFailOver": true,
        "StrategyType": "wrr"
    }

响应示例

{
   "ResponseMetadata": {
       "RequestId": "20210719152*****02252431530006E032",
       "Action": "UpdateDomainConfig",
       "Version": "2023-01-01",
       "Service": "dcdn",
       "Region": "cn-south-1"
    },
}