You need to enable JavaScript to run this app.
导航
新增加速域名
最近更新时间:2024.01.23 11:29:59首次发布时间:2023.03.07 10:47:42

API说明

API名称:CreateDomain。
API域名:open.volcengineapi.com 。
API描述:新增全站加速域名。在添加域名时,您可以统一设置此域名需要的配置项。

URI参数

公共参数

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

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

注意

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

请求正文

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

参数名称
是否必选
参数类型
参数说明
示例
Domains
[ ]String
您可以指定添加的加速域名,具体的添加规则如下:
  • 单个账号最多添加50个域名。如需提升单个账号下添加域名数量的上限,请提交工单。
  • 中国内地的域名需要完成域名备案后才能添加使用。
  • 全站加速支持添加泛域名,泛域名需要以(.)作为首位字符,不能以(*.)作为首位字符且不能以(.)作为末位字符。当前全站加速仅支持二级、三级、四级泛域名。
  • 全站加速仅允许单个加速域名添加一次。即单个域名只能添加到您所有开通DCDN服务账号中的一个,不能重复添加。
  • 域名字符串以(.)分割,包括末尾(.)在内总长度不超过254个字符。
  • 单个字符串由字母、数字、连字符(-)组成,连字符(-)不能出现在字符串的头部或者尾部。 单个字符串长度不超过63个字符。
["www.test1.com","www.test2.com"]
Origin
Origin
源站配置。
-
StrategyType
String
回源策略,支持取值:
  • wrr:加权轮询。源站类型为 TOS 时,回源策略默认为 wrr ,不支持配置。
  • optimum:择优。
wrr
ProjectName
String
您可以指定当前创建域名的归属项目,默认归于default项目。
default
Scope
String
加速范围,当前仅对白名单用户开放。具体取值如下:
  • domestic(默认值):中国大陆。
  • overseas:中国大陆以外区域。
  • global:全球。
domestic
Https
Https
Https 加速配置。
-
EnableFailOver
Boolean
是否开启主备容灾功能,默认不启用,源站类型为 TOS 时,不支持启用。支持取值:
  • true:启用。
  • false:不启用。
false
IPv6Switch
Boolean
是否开启 IPv6 功能,通过 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=CreateDomain&<其他公共请求参数>
    {
        "Domains": ["www.test1.com","www.test2.com"],
        "ProjectName": "default",
        "Origin": {
            "Origins": [
                {
                    "Name": "1.1.1.3",
                    "Port": 12,
                    "Weight": 1
                }
            ],
            "OriginType": "IP",
            "OriginProtocolType": "http",
            "BackupOriginType": "IP",
            "BackupOrigins": []
        },
        "StrategyType": "wrr",
        "EnableFailOver": false
    }

响应示例

{
   "ResponseMetadata": {
       "RequestId": "2021071915224101*****431530006E032",
       "Action": "CreateDomain",
       "Version": "2023-01-01",
       "Service": "dcdn",
       "Region": "cn-south-1"
    },
   "Result":  null
}