请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domains	String[]	是	指定需要添加的加速域名。规则如下：单个账号最多添加 50 个域名。如选择中国大陆或全球作为加速区域，您需要对您的域名完成备案后才能添加使用。全站加速支持添加泛域名，泛域名需要以`.`开头，不能以 `*.` 开头且不能以 `.` 结尾。当前全站加速仅支持二级和三级泛域名。添加的域名不可与全站加速现有域名重复，不同账号下也不允许重名。域名总长度不超过 254 个字符。域名包含由`.`连接的多个标签组成。单个标签可包含字母、数字、连字符（`-`），不能以连字符开头或结尾。单个标签长度不超过 63 个字符。	`["www.example.com"]`
ProjectName	String	否	您可以指定当前创建域名的归属项目，默认归于default项目。	`default`
Scope	String	否	加速区域。取值如下： `domestic`（默认值）：中国大陆。 `overseas`：中国大陆以外区域。 `global`：全球。	`domestic`
StrategyType	String	是	回源策略，支持取值： `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	否	上传协议优化配置。开启上传协议优化后，全站加速通过自研协议栈优化策略，提升文件接收和传输性能。	`-`
IPv6Switch	Boolean	否	是否开启 IPv6 功能，通过 IPv6 协议访问全站加速节点和源站。默认不启用，支持取值： true：启用。 false：不启用。	`false`
WebSocket	Object	否	WebSockect 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。	`-`
PremiumBGPPackage	Object	否	精品公网（跨境质量优化）配置。开启后优先走精品公网跨境链路，优化中国大陆用户访问海外业务的质量与成功率。

返回参数

本接口成功时无业务返回参数，仅返回公共响应体 ResponseMetadata（包含 RequestId、Action、Version、Service、Region）；调用出错时返回错误信息。

请求示例

POST https://open.volcengineapi.com?Action=CreateDomain&Version=2023-01-01
{
    "Domains": [
        "dcdn.example.com"
    ],
    "ProjectName": "default",
    "Scope": "domestic",
    "StrategyType": "wrr",
    "EnableFailOver": true,
    "Origin": {
        "Origins": [
            {
                "Name": "198.51.100.99",
                "Weight": 1,
                "Type": "IP",
                "Port": 443
            }
        ],
        "OriginType": "IP",
        "OriginProtocolType": "https",
        "BackupOrigins": [
            {
                "Name": "198.51.100.100",
                "Weight": 1,
                "Type": "IP"
            }
        ],
        "ResponseTimeout": 10,
        "ResponseHeader": {
            "Enable": false,
            "HeaderInfo": []
        },
        "OriginHost": {
            "Enable": true,
            "HostInfo": "www.example.com"
        },
        "OriginSni": {
            "Enable": true,
            "SniInfo": "www.example.com"
        },
        "OriginRange": {
            "Enable": false
        },
        "RequestHeader": {
            "Enable": false,
            "HeaderInfo": []
        },
        "ConditionalOrigins": [],
        "FollowRedirect": {
            "Enable": true,
            "MaxTries": 3
        },
        "GAOriginProbe": {
            "Enable": false
        },
        "OriginIPv6": {
            "Enable": false,
            "Strategy": ""
        },
        "TosPrivateAccess": false
    },
    "Https": {
        "EnableHttps": false
    },
    "Cache": {
        "Enable": true,
        "AdaptCache": true,
        "StatusCodeCacheRule": {
            "Enable": true,
            "Rules": [
                {
                    "Status": "404",
                    "CacheTime": 10,
                    "CacheTimeUnit": "second",
                    "RespUrl": "http://www.example.com/error.html"
                }
            ]
        }
    },
    "RefererAccess": {
        "Enable": true,
        "FilterType": "WhiteList",
        "AllowNone": true,
        "FilterList": [
            "dcdn.example.com"
        ]
    },
    "WebSocket": {
        "Enable": false
    },
    "GzipCompress": {
        "Enable": false
    },
    "BrCompress": {
        "Enable": false
    },
    "StaticOptimization": {
        "H2Priority": false
    },
    "UploadOptimize": {
        "Enable": false
    },
    "IPv6Switch": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250826140526B53949A66830B05E64A4",
        "Action": "CreateDomain",
        "Version": "2023-01-01",
        "Service": "DCDN",
        "Region": "cn-north-01"
    }
}

错误码

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

最近更新时间：2026.08.19 16:43:17

这个页面对您有帮助吗？

有用

无用

全站加速

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #